Skip to content
Latchkey
Start Free

deploy workflow (pytest-dev/pytest-flask)

The deploy workflow from pytest-dev/pytest-flask, explained and optimized by Latchkey.

B

CI health: B - good

Point runs-on at Latchkey and get 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: pytest-dev/pytest-flask.github/workflows/deploy.ymlLicense MITView source

What it does

This is the deploy workflow from the pytest-dev/pytest-flask 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)
name: deploy

on:
  workflow_dispatch:
    inputs:
      version:
        description: 'Release version'
        required: true
        default: '1.2.3'

jobs:

  package:
    runs-on: ubuntu-latest
    env:
      SETUPTOOLS_SCM_PRETEND_VERSION: ${{ github.event.inputs.version }}

    steps:
    - uses: actions/checkout@v3

    - name: Build and Check Package
      uses: hynek/build-and-inspect-python-package@v1.5

  deploy:
    needs: package
    runs-on: ubuntu-latest
    environment: deploy
    permissions:
      id-token: write  # For PyPI trusted publishers.
      contents: write  # For tag and release notes.

    steps:
    - uses: actions/checkout@v3

    - name: Download Package
      uses: actions/download-artifact@v3
      with:
        name: Packages
        path: dist

    - name: Publish package to PyPI
      uses: pypa/gh-action-pypi-publish@v1.8.5

    - name: Push tag
      run: |
        git config user.name "pytest bot"
        git config user.email "pytestbot@gmail.com"
        git tag --annotate --message=${{ github.event.inputs.version }} ${{ github.event.inputs.version }} ${{ github.sha }}
        git push origin ${{ github.event.inputs.version }}

    - name: GitHub Release
      uses: softprops/action-gh-release@v1
      with:
        files: dist/*
        tag_name: ${{ github.event.inputs.version }}

The same workflow, on Latchkey

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

name: deploy
 
on:
  workflow_dispatch:
    inputs:
      version:
        description: 'Release version'
        required: true
        default: '1.2.3'
 
jobs:
 
  package:
    timeout-minutes: 30
    runs-on: latchkey-small
    env:
      SETUPTOOLS_SCM_PRETEND_VERSION: ${{ github.event.inputs.version }}
 
    steps:
    - uses: actions/checkout@v3
 
    - name: Build and Check Package
      uses: hynek/build-and-inspect-python-package@v1.5
 
  deploy:
    timeout-minutes: 30
    needs: package
    runs-on: latchkey-small
    environment: deploy
    permissions:
      id-token: write  # For PyPI trusted publishers.
      contents: write  # For tag and release notes.
 
    steps:
    - uses: actions/checkout@v3
 
    - name: Download Package
      uses: actions/download-artifact@v3
      with:
        name: Packages
        path: dist
 
    - name: Publish package to PyPI
      uses: pypa/gh-action-pypi-publish@v1.8.5
 
    - name: Push tag
      run: |
        git config user.name "pytest bot"
        git config user.email "pytestbot@gmail.com"
        git tag --annotate --message=${{ github.event.inputs.version }} ${{ github.event.inputs.version }} ${{ github.sha }}
        git push origin ${{ github.event.inputs.version }}
 
    - name: GitHub Release
      uses: softprops/action-gh-release@v1
      with:
        files: dist/*
        tag_name: ${{ github.event.inputs.version }}

What changed

3 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

actions/checkout actions/download-artifact softprops/action-gh-release