Repo Commands workflow (PrismarineJS/mineflayer)

The Repo Commands workflow from PrismarineJS/mineflayer, explained and optimized by Latchkey.

What it does

This is the Repo Commands workflow from the PrismarineJS/mineflayer 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

name: Repo Commands


on:
  issue_comment:        # Handle comment commands

    types: [created]

  pull_request:         # Handle renamed PRs

    types: [edited]


jobs:
  comment-trigger:
    runs-on: ubuntu-latest

    steps:
    - name: Check out repository

      uses: actions/checkout@v3

    - name: Run command handlers

      uses: PrismarineJS/prismarine-repo-actions@master

      with:
        # NOTE: You must specify a Personal Access Token (PAT) with repo access here. While you can use the default GITHUB_TOKEN, actions taken with it will not trigger other actions, so if you have a CI workflow, commits created by this action will not trigger it.

        token: ${{ secrets.PAT_PASSWORD }}

        # See `Options` section below for more info on these options

        install-command: npm install

        /fixlint.fix-command: npm run fix

The same workflow, on Latchkey

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

name: Repo Commands



on:

  issue_comment:        # Handle comment commands

    types: [created]

  pull_request:         # Handle renamed PRs

    types: [edited]



concurrency:

  group: ${{ github.workflow }}-${{ github.ref }}

  cancel-in-progress: true



jobs:

  comment-trigger:

    timeout-minutes: 30

    runs-on: latchkey-small

    steps:

    - name: Check out repository

      uses: actions/checkout@v3

    - name: Run command handlers

      uses: PrismarineJS/prismarine-repo-actions@master

      with:

        # NOTE: You must specify a Personal Access Token (PAT) with repo access here. While you can use the default GITHUB_TOKEN, actions taken with it will not trigger other actions, so if you have a CI workflow, commits created by this action will not trigger it.

        token: ${{ secrets.PAT_PASSWORD }}

        # See `Options` section below for more info on these options

        install-command: npm install

        /fixlint.fix-command: npm run fix

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.

1 third-party action is referenced by a movable tag. Pin it 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 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