Code Formatting workflow (Nya-Foundation/NyaProxy)
The Code Formatting workflow from Nya-Foundation/NyaProxy, explained and optimized by Latchkey.
CI health: C - fair
Point runs-on at Latchkey and get run de-duplication, job timeouts, self-healing for flaky steps, and up to 58% lower cost, applied automatically.
What it does
This is the Code Formatting workflow from the Nya-Foundation/NyaProxy 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: Code Formatting
# run black and isort on your local machine before pushing changes
# isort --profile black .
on:
pull_request:
branches: ["staging", "main"]
paths:
- '**/*.py'
push:
branches: ["dev"]
paths:
- '**/*.py'
jobs:
format:
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
steps:
- name: Generate GitHub App Token
id: generate-token
# Uses App ID and Private Key secrets to generate a short-lived installation token
uses: actions/create-github-app-token@v2
with:
app-id: ${{ secrets.CI_APP_ID }}
private-key: ${{ secrets.CI_APP_PRIVATE_KEY }}
- name: Checkout code
uses: actions/checkout@v4
with:
ref: ${{ github.head_ref }}
token: ${{ steps.generate-token.outputs.token }}
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.12'
cache: 'pip'
cache-dependency-path: |
pyproject.toml
setup.py
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install black isort
- name: Run isort with black profile
run: |
isort --profile black .
- name: Check for changes
id: git-check
run: |
git diff --exit-code || echo "has_changes=true" >> $GITHUB_OUTPUT
- name: Commit changes
if: steps.git-check.outputs.has_changes == 'true' && github.event_name == 'pull_request'
run: |
git config --local user.email "github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
git commit -am "chore(format): Apply automatic formatting [skip ci]" || echo "No changes to commit"
git pushThe same workflow, on Latchkey
Removes redundant runs and caps runaway jobs. Added and changed lines are highlighted.
name: Code Formatting # run black and isort on your local machine before pushing changes # isort --profile black . on: pull_request: branches: ["staging", "main"] paths: - '**/*.py' push: branches: ["dev"] paths: - '**/*.py' concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: format: timeout-minutes: 30 runs-on: latchkey-small permissions: contents: write pull-requests: write steps: - name: Generate GitHub App Token id: generate-token # Uses App ID and Private Key secrets to generate a short-lived installation token uses: actions/create-github-app-token@v2 with: app-id: ${{ secrets.CI_APP_ID }} private-key: ${{ secrets.CI_APP_PRIVATE_KEY }} - name: Checkout code uses: actions/checkout@v4 with: ref: ${{ github.head_ref }} token: ${{ steps.generate-token.outputs.token }} - name: Set up Python uses: actions/setup-python@v5 with: python-version: '3.12' cache: 'pip' cache-dependency-path: | pyproject.toml setup.py - name: Install dependencies run: | python -m pip install --upgrade pip pip install black isort - name: Run isort with black profile run: | isort --profile black . - name: Check for changes id: git-check run: | git diff --exit-code || echo "has_changes=true" >> $GITHUB_OUTPUT - name: Commit changes if: steps.git-check.outputs.has_changes == 'true' && github.event_name == 'pull_request' run: | git config --local user.email "github-actions[bot]@users.noreply.github.com" git config --local user.name "github-actions[bot]" git commit -am "chore(format): Apply automatic formatting [skip ci]" || echo "No changes to commit" git push
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 useslatchkey-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.
What Latchkey heals here
This workflow has steps that commonly fail on transient issues (network, registries, flaky browsers). On Latchkey managed runners they are detected, retried, and self-healed instead of failing your build:
- Dependency installs
This workflow runs 1 job per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.