Release changelog workflow (fastapi-practices/fastapi-best-architecture)

The Release changelog workflow from fastapi-practices/fastapi-best-architecture, explained and optimized by Latchkey.

What it does

This is the Release changelog workflow from the fastapi-practices/fastapi-best-architecture 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: Release changelog

on:
  workflow_run:
    workflows: ['Check version']
    types:
      - completed

jobs:
  changelog:
    runs-on: ubuntu-latest
    if: ${{ github.event.workflow_run.conclusion == 'success' }}
    steps:
      - name: Checkout code
        uses: actions/checkout@v6
        with:
          ref: master

      - uses: rhysd/changelog-from-release/action@v3
        with:
          file: CHANGELOG.md
          pull_request: true
          commit_summary_template: 'Update the changelog for %s'
          args: -c
          github_token: ${{ secrets.GH_TOKEN }}

The same workflow, on Latchkey

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

name: Release changelog
 
on:
  workflow_run:
    workflows: ['Check version']
    types:
      - completed
 
jobs:
  changelog:
    timeout-minutes: 30
    runs-on: latchkey-small
    if: ${{ github.event.workflow_run.conclusion == 'success' }}
    steps:
      - name: Checkout code
        uses: actions/checkout@v6
        with:
          ref: master
 
      - uses: rhysd/changelog-from-release/action@v3
        with:
          file: CHANGELOG.md
          pull_request: true
          commit_summary_template: 'Update the changelog for %s'
          args: -c
          github_token: ${{ secrets.GH_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.
• 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