@minkimcello/georgia

When PR is Created

Actions

1. *NEW* georgia/sha-version generates new package version using SHA.

   • Click here to see how the action works.

2. actions/npm to publish

3. Generate comment on PR to expose package with Danger.

Notes

I've been playing around with Github's Octokit. Octokit is capable of creating/editing comments but having to tell it where makes it a little more complicated. For now we've stayed with Danger-JS and to mitigate its current bugs we're running the installation and its command in-line in the workflow itself. It's a temporary solution and I can look into Danger-Danger next week.

When PR is Merged

Actions

1. *NEW* georgia/filter-by-commit to prevent the workflow from running if commit message matches the argument of this action. We're passing in skip-action to accommodate the auto-commit's message.

   • Click here to see how the action works.

2. *NEW* georgia/fetch-labels-npm retrieves labels of the most recently-merged PR and exports the appropriate label as a variable to be accessible elsewhere in the workflow.

   • Click here to see how the action works.

3. actions/npm to update version with the label exported from the previous action.

4. *NEW* georgia/commit-and-push is a custom action that takes in an argument for what files you want to push back to the repo. We're passing in package.json with its new package version.

   • Click here to see how the action works.

5. actions/npm to publish.

Notes

By creating our own actions, we've made this workflow much more modular and re-usable.

We've gone from this:

publish:
  name: Commit & Publish
  runs-on: ubuntu-latest
  needs: tests
  steps:
  - uses: actions/checkout@v1
  - name: Commit & Publish
    run: |
      if [[ "$(git log -1 --pretty=%B)" =~ "[ci skip]" ]]
      then 
        echo Skipping because this commit is automated
      else
        # git setup
        git remote set-url origin https://${GITHUB_TOKEN}:[e-mail]/${GITHUB_REPOSITORY}.git
        git fetch origin +refs/heads/*:refs/heads/*
        branch=$(printf "%s\n" "${GITHUB_REF#*refs\/heads\/}")
        git checkout $branch
        if [ "${#SEMVER_USER_NAME}" -ne "0" -a "${#SEMVER_USER_EMAIL}" -ne "0" ]
        then
          git_config_email=$SEMVER_USER_NAME
          git_config_name=$SEMVER_USER_EMAIL
        else
          git_config_email="`node -e \"console.log(require('./package.json').author.email)\"`"
          git_config_name="`node -e \"console.log(require('./package.json').author.name)\"`"
        fi
        git config user.email $git_config_email
        git config user.name $git_config_name
        # install hub
        wget https://github.com/github/hub/releases/download/v2.12.3/hub-linux-amd64-2.12.3.tgz
        tar -zxvf hub-linux-amd64-2.12.3.tgz
        cd hub-linux-amd64-2.12.3
        sudo ./install && cd ..
        labels=$(hub pr list -s merged -L 1 -f %L)
        # use labels to decide how to increment and publish
        if [[ "$labels" =~ "major" ]]
        then
          echo Skipping because major release should be published manually
        else 
          if [[ "$labels" =~ "minor" ]]
          then
            npm version minor --no-git-tag-version 
          else
            npm version patch --no-git-tag-version
          fi
          git add package.json
          current="`node -e \"console.log(require('./package.json').version)\"`"
          git commit -m "Release version $current [ci skip]"
          git push origin HEAD
          echo "//registry.npmjs.org/:_authToken=$NPM_AUTH_TOKEN" > ~/.npmrc
          npm publish --access=public
        fi
      fi
    env:
      GITHUB_TOKEN: ${{ secrets.MK_TOKEN }} 
      NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
      SEMVER_USER_NAME: ${{ secrets.SEMVER_USER_NAME }}
      SEMVER_USER_EMAIL: ${{ secrets.SEMVER_USER_EMAIL }}

To this:

publish:
  name: Commit & Publish
  runs-on: ubuntu-latest
  needs: tests
  steps:
  - uses: actions/checkout@v1
  
  - name: Filter by Commit Message
    uses: taras/georgia/.github/actions/filter-by-commit@release-1.0.0
    with:
      filter: skip-actions

  - name: list labels of last merged pr
    uses: minkimcello/js-action@master
    with:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  
  - name: npm version using label variable set from previous step
    uses: actions/npm@master
    with:
      args: version $NPM_VERSION --no-git-tag-version # see below 

  - name: commit and push to repo
    uses: taras/georgia/.github/actions/git-push@release-1.0.0
    with:
      add: package.json
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  
  - name: publish
    uses: actions/npm@master
    with:
      args: publish --access=public
    env:
      NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

# --no-git-tag-version is necessary to prevent it from triggering a commit

Setup Instructions

Setup has become much simpler now:

1. add NPM_AUTH_TOKEN from npmjs in secrets

2. customize test procedures in the two workflows (temporary solution)

3. copy/paste the two workflow files.

   • all the actions are called from the repo and not locally so they should work as-is.