Improve GitHub Actions template

Is your feature request related to a problem? Please describe. The CI template that Ship.js provides is not correct for people wants to use Release Snapshot.

Describe the solution you’d like Add example CI configs at “Release Snapshot” section.

Describe alternatives you’ve considered Add example config. For example GitHub Actions:

name: Ship js trigger
on:
+  pull_request:
+   types:
+      - closed

-   push:
-     branches:
-       - develop

jobs:
  build:
    name: Release
    runs-on: ubuntu-latest
+  if: github.event.pull_request.merged == true && startsWith(github.head_ref, 'releases/v')

    steps:
      - uses: actions/checkout@v2
        with:
          ref: develop
+        fetch-depth: 0

      - uses: actions/setup-node@v1
        with:
          registry-url: "https://registry.npmjs.org"
      - run: |
          if [ -f "yarn.lock" ]; then
            yarn install
          else
            npm install
          fi
      - run: npx shipjs trigger
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
          # SLACK_INCOMING_HOOK: ${{ secrets.SLACK_INCOMING_HOOK }}

CircleCi is… I don’t know about that very much😅

Additional context Or add step when use npx shipjs setup. Do you want to use "Release Snapshot"? y/N. If we add this step, we should refactor addCircleCIConfig.js and addGitHubActions.js.

[eunjae-lee]

@tyankatsu0105 yes, the flow will run on every pr closed, which is not ideal, but the flow gets closed.

You can change the staging branch name with this config. It is not documented, but it works.

Maybe we should use startsWith(github.head_ref, 'releases/v') as you said. GitHub provides this better control which CircleCI doesn’t have. So we should leverage that.

And if we later document getStagingBranchName then we will put WARNING so that they can update their github workflow as well.

Okay, let’s 🛳 it

[tyankatsu0105]

Umm… @eunjae-lee If not use startsWith(github.head_ref, 'releases/v'), this flow will run every PR is closed. It’s not good.

Btw, How can we change the release branch name?