tag-release workflow (kubernetes/node-problem-detector)

The tag-release workflow from kubernetes/node-problem-detector, explained and optimized by Latchkey.

What it does

This is the tag-release workflow from the kubernetes/node-problem-detector repository, a real project running GitHub Actions. It is shown here with attribution under its Apache-2.0 license.

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

The workflow

name: tag-release

on:
  push:
    branches:
      - master
      - 'release-*'
    paths:
      - version.txt

permissions:
  contents: read

jobs:
  tag:
    if: ${{ github.repository == 'kubernetes/node-problem-detector' }}
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - name: Harden Runner
        uses: step-security/harden-runner@9af89fc71515a100421586dfdb3dc9c984fbf411 # v2.19.4
        with:
          egress-policy: audit
      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
        with:
          fetch-depth: 0
      - run: /usr/bin/git config --global user.email actions@github.com
      - run: /usr/bin/git config --global user.name 'GitHub Actions Release Tagger'
      - run: hack/tag-release.sh
        id: tag_release
    outputs:
      release_tag: ${{ steps.tag_release.outputs.release_tag }}

The same workflow, on Latchkey

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

name: tag-release on:  push:    branches:      - master      - 'release-*'    paths:      - version.txt permissions:  contents: read concurrency:  group: ${{ github.workflow }}-${{ github.ref }}  cancel-in-progress: true jobs:  tag:    timeout-minutes: 30    if: ${{ github.repository == 'kubernetes/node-problem-detector' }}    runs-on: latchkey-small    permissions:      contents: write    steps:      - name: Harden Runner        uses: step-security/harden-runner@9af89fc71515a100421586dfdb3dc9c984fbf411 # v2.19.4        with:          egress-policy: audit      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0        with:          fetch-depth: 0      - run: /usr/bin/git config --global user.email actions@github.com      - run: /usr/bin/git config --global user.name 'GitHub Actions Release Tagger'      - run: hack/tag-release.sh        id: tag_release    outputs:      release_tag: ${{ steps.tag_release.outputs.release_tag }} 

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.

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

Actions used in this workflow

Frequently asked questions

References

• GitHub Actions documentation