Release workflow (dask/dask-ml)

The Release workflow from dask/dask-ml, explained and optimized by Latchkey.

What it does

This is the Release workflow from the dask/dask-ml repository, a real project running GitHub Actions. It is shown here with attribution under its BSD-3-Clause license.

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

The workflow

name: Release

on:
  release:
    types:
      - created

permissions:
  contents: read

jobs:
  check-package:
    name: Build & inspect our package.
    runs-on: ubuntu-latest
    if: ${{ github.repository }} == 'dask/dask-ml'
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: hynek/build-and-inspect-python-package@v2

  release-pypi:
    permissions:
      id-token: write
      contents: read
    name: Publish released package to pypi.org
    environment: release-pypi
    runs-on: ubuntu-latest
    needs: check-package

    steps:
      - name: Download packages built by build-and-inspect-python-package
        uses: actions/download-artifact@v4
        with:
          name: Packages
          path: dist

      - name: Upload package to PyPI
        uses: pypa/gh-action-pypi-publish@release/v1

The same workflow, on Latchkey

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

name: Release
 
on:
  release:
    types:
      - created
 
permissions:
  contents: read
 
jobs:
  check-package:
    timeout-minutes: 30
    name: Build & inspect our package.
    runs-on: latchkey-small
    if: ${{ github.repository }} == 'dask/dask-ml'
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: hynek/build-and-inspect-python-package@v2
 
  release-pypi:
    timeout-minutes: 30
    permissions:
      id-token: write
      contents: read
    name: Publish released package to pypi.org
    environment: release-pypi
    runs-on: latchkey-small
    needs: check-package
 
    steps:
      - name: Download packages built by build-and-inspect-python-package
        uses: actions/download-artifact@v4
        with:
          name: Packages
          path: dist
 
      - name: Upload package to PyPI
        uses: pypa/gh-action-pypi-publish@release/v1
 

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.

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.

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