changelog workflow (pykale/pykale)

The changelog workflow from pykale/pykale, 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: pykale/pykale.github/workflows/changelog.ymlLicense MITView source

What it does

This is the changelog workflow from the pykale/pykale 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)

# This workflow will generate a log of changes automatically upon a new release.
# See https://github.com/marketplace/actions/changelog-ci

name: changelog

on:
  pull_request:
    types: [opened]

jobs:
  log-changes:
    name: Log changes
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
        with:
          repository: ${{ github.event.pull_request.head.repo.full_name }}
          ref: ${{ github.event.pull_request.head.ref }}
          # Keep checkout shallow; changelog-ci handles unshallow internally.
          # Using fetch-depth: 0 causes changelog-ci to fail with:
          # "fatal: --unshallow on a complete repository does not make sense"
          fetch-depth: 1
          token: ${{ secrets.GITHUB_TOKEN }}
      - name: Run changelog
        uses: saadmk11/changelog-ci@v1.2.0
        with:
          changelog_filename: .github/CHANGELOG.md
          config_file: .github/changelog-ci-config.json
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

The same workflow, on Latchkey

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

# This workflow will generate a log of changes automatically upon a new release.
# See https://github.com/marketplace/actions/changelog-ci
 
name: changelog
 
on:
  pull_request:
    types: [opened]
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  log-changes:
    timeout-minutes: 30
    name: Log changes
    runs-on: latchkey-small
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
        with:
          repository: ${{ github.event.pull_request.head.repo.full_name }}
          ref: ${{ github.event.pull_request.head.ref }}
          # Keep checkout shallow; changelog-ci handles unshallow internally.
          # Using fetch-depth: 0 causes changelog-ci to fail with:
          # "fatal: --unshallow on a complete repository does not make sense"
          fetch-depth: 1
          token: ${{ secrets.GITHUB_TOKEN }}
      - name: Run changelog
        uses: saadmk11/changelog-ci@v1.2.0
        with:
          changelog_filename: .github/CHANGELOG.md
          config_file: .github/changelog-ci-config.json
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_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.

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.

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

actions/checkout