Release to PyPI workflow (InfuseAI/colab-xterm)

The Release to PyPI workflow from InfuseAI/colab-xterm, explained and optimized by Latchkey.

CI health: D - needs work

Point runs-on at Latchkey and get caching, run de-duplication, job timeouts, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: InfuseAI/colab-xterm.github/workflows/release.ymlLicense Apache-2.0View source

What it does

This is the Release to PyPI workflow from the InfuseAI/colab-xterm 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

workflow (.yml)

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: Release to PyPI

on:
  push:
    tags: 'v*'


jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        python-version: [ "3.10" ]

    steps:
      - uses: actions/checkout@v2
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}
      - name: Release
        run: |
          # get version from GITHUB_REF
          # input: "refs/tags/v0.1.0"
          # outpu: "0.1.0"

          # update version number
          echo "${GITHUB_REF:11}" > ./colabxterm/VERSION

          # generate pypirc
          echo "$PYPIRC" > $HOME/.pypirc

          # release to PyPI
          make release
        env:
          PYPIRC: ${{ secrets.PYPI }}

The same workflow, on Latchkey

Estimated ~20% faster on cache hits, plus fewer wasted runs and a safer supply chain. Added and changed lines are highlighted.

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
name: Release to PyPI
 
on:
  push:
    tags: 'v*'
 
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
    runs-on: latchkey-small
    strategy:
      fail-fast: false
      matrix:
        python-version: [ "3.10" ]
 
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v2
        with:
          cache: 'pip'
          python-version: ${{ matrix.python-version }}
      - name: Release
        run: |
          # get version from GITHUB_REF
          # input: "refs/tags/v0.1.0"
          # outpu: "0.1.0"
 
          # update version number
          echo "${GITHUB_REF:11}" > ./colabxterm/VERSION
 
          # generate pypirc
          echo "$PYPIRC" > $HOME/.pypirc
 
          # release to PyPI
          make release
        env:
          PYPIRC: ${{ secrets.PYPI }}

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.
Cache dependency installs on the setup step so they are served from cache.
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

actions/checkout actions/setup-python