Release workflow (jondot/hygen)

The Release workflow from jondot/hygen, explained and optimized by Latchkey.

CI health: C - fair

Point runs-on at Latchkey and get run de-duplication, job timeouts, SHA-pinned actions, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: jondot/hygen.github/workflows/cd.ymlLicense MITView source

What it does

This is the Release workflow from the jondot/hygen repository, a real project running GitHub Actions. It is shown here with attribution under its MIT license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

workflow (.yml)

name: Release

# secrets setup:
# - NODE_AUTH_TOKEN: ${{secrets.npm_token}}
# - GITHUB_TOKEN (inherent in the CI and no need to set up, used by standalone.js + gh releaser)

on:
  push:
    tags:
      - 'v[0-9]+.[0-9]+.[0-9]+'

jobs:
  build-before-publish:
    uses: ./.github/workflows/ci.yml
  publish:
    needs: build-before-publish
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Use Node.js
        uses: actions/setup-node@v2
        with:
          node-version: 17.x
          cache: 'yarn'
          registry-url: 'https://registry.npmjs.org'
      - run: yarn install
      - run: yarn build
      - run: yarn hygen:build -- init self # smoke test the built bundle
      - run: npm publish # add the package to npm
        env:
          NODE_AUTH_TOKEN: ${{secrets.NODE_AUTH_TOKEN}}
      - run: yarn standalone # creates binaries
      - name: Github Release # adds the binaries to github release
        uses: softprops/action-gh-release@v1
        with:
          files: "standalone/*"
      - name: Extract version
        id: extract-version
        run: |
          printf "::set-output name=%s::%s\n" tag-name "${GITHUB_REF#refs/tags/}"
      - uses: mislav/bump-homebrew-formula-action@v1
        with:
          formula-path: hygen.rb
          homebrew-tap: jondot/homebrew-tap
          download-url: "https://github.com/jondot/hygen/releases/download/${{ steps.extract-version.outputs.tag-name }}/hygen.macos.${{ steps.extract-version.outputs.tag-name }}.tar.gz"
          commit-message: updating formula for Hygen
        env:
          COMMITTER_TOKEN: ${{ secrets.COMMITTER_TOKEN }}

The same workflow, on Latchkey

Removes redundant runs and caps runaway jobs. Added and changed lines are highlighted.

name: Release
 
# secrets setup:
# - NODE_AUTH_TOKEN: ${{secrets.npm_token}}
# - GITHUB_TOKEN (inherent in the CI and no need to set up, used by standalone.js + gh releaser)
 
on:
  push:
    tags:
      - 'v[0-9]+.[0-9]+.[0-9]+'
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build-before-publish:
    timeout-minutes: 30
    uses: ./.github/workflows/ci.yml
  publish:
    timeout-minutes: 30
    needs: build-before-publish
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v2
      - name: Use Node.js
        uses: actions/setup-node@v2
        with:
          node-version: 17.x
          cache: 'yarn'
          registry-url: 'https://registry.npmjs.org'
      - run: yarn install
      - run: yarn build
      - run: yarn hygen:build -- init self # smoke test the built bundle
      - run: npm publish # add the package to npm
        env:
          NODE_AUTH_TOKEN: ${{secrets.NODE_AUTH_TOKEN}}
      - run: yarn standalone # creates binaries
      - name: Github Release # adds the binaries to github release
        uses: softprops/action-gh-release@v1
        with:
          files: "standalone/*"
      - name: Extract version
        id: extract-version
        run: |
          printf "::set-output name=%s::%s\n" tag-name "${GITHUB_REF#refs/tags/}"
      - uses: mislav/bump-homebrew-formula-action@v1
        with:
          formula-path: hygen.rb
          homebrew-tap: jondot/homebrew-tap
          download-url: "https://github.com/jondot/hygen/releases/download/${{ steps.extract-version.outputs.tag-name }}/hygen.macos.${{ steps.extract-version.outputs.tag-name }}.tar.gz"
          commit-message: updating formula for Hygen
        env:
          COMMITTER_TOKEN: ${{ secrets.COMMITTER_TOKEN }}

What changed

Run on Latchkey managed runners with one line (runs-on), which apply the fixes below automatically and self-heal transient failures. This example uses latchkey-small; pick the runner size that fits the job.
Cancel superseded runs when a branch or PR gets a newer push.
Add a job timeout so a hung step cannot burn hours of runner time.

2 third-party actions are referenced by a movable tag. Pin them to the commit SHA (Latchkey resolves and applies this automatically) so a repointed tag cannot change what runs.

What Latchkey heals here

This workflow has steps that commonly fail on transient issues (network, registries, flaky browsers). On Latchkey managed runners they are detected, retried, and self-healed instead of failing your build:

Dependency installs

This workflow runs 2 jobs per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow

actions/checkout actions/setup-node softprops/action-gh-release