Reusable Workflows¶

Complete end-to-end CI/CD workflows that can be called from your repository.

🤖 AI-Generated Content

This documentation was generated with AI assistance and is still being audited. Some, or potentially a lot, of this information may be inaccurate. Learn more.

Overview¶

Reusable workflows provide complete CI/CD pipelines with multiple jobs orchestrated together. They offer:

Complete Pipelines: Quality checks, testing, security, and building
Matrix Testing: Test across multiple Python versions and operating systems
Parallel Execution: Jobs run in parallel for faster results
Flexible Configuration: Extensive input parameters for customization

Available Workflows¶

python-ci.yml ¶

Complete CI pipeline with quality, test, security, and performance jobs.

Use this for: Continuous integration on push and pull requests.

jobs:
  ci:
    uses: provide-io/ci-tooling/.github/workflows/python-ci.yml@v0.0.1
    with:
      python-version: '3.11'

python-release.yml ¶

Complete release pipeline with testing, building, and PyPI publishing.

Use this for: Automated releases on version tags.

jobs:
  release:
    uses: provide-io/ci-tooling/.github/workflows/python-release.yml@v0.0.1
    with:
      python-version: '3.11'
    secrets:
      pypi-token: ${{ secrets.PYPI_TOKEN }}

Workflows vs Actions¶

When to Use Workflows¶

Reusable workflows are best when you need: - Complete multi-job pipelines - Job orchestration and dependencies - Matrix testing across configurations - Standardized CI/CD process - Minimal configuration

When to Use Actions¶

Individual actions are best when you need: - Custom workflow structure - Fine-grained control over steps - Integration with other actions - Custom job dependencies - Unique workflow requirements

Calling Reusable Workflows¶

Basic Syntax¶

jobs:
  job-name:
    uses: provide-io/ci-tooling/.github/workflows/workflow-name.yml@version
    with:
      input-name: value
    secrets:
      secret-name: ${{ secrets.SECRET_NAME }}

Version Pinning¶

# Recommended: Use release tag
uses: provide-io/ci-tooling/.github/workflows/python-ci.yml@v0.0.1

# Acceptable: Use commit SHA
uses: provide-io/ci-tooling/.github/workflows/python-ci.yml@abc123def

# Not recommended: Use branch (unstable)
uses: provide-io/ci-tooling/.github/workflows/python-ci.yml@main

Common Patterns¶

CI on Push and PR¶

name: CI

on:
  push:
    branches: [main, develop]
  pull_request:
    branches: [main]

jobs:
  ci:
    uses: provide-io/ci-tooling/.github/workflows/python-ci.yml@v0.0.1
    with:
      python-version: '3.11'
      coverage-threshold: 80
      run-security: true

Release on Tags¶

name: Release

on:
  push:
    tags:
      - 'v*'

jobs:
  release:
    uses: provide-io/ci-tooling/.github/workflows/python-release.yml@v0.0.1
    with:
      python-version: '3.11'
    secrets:
      pypi-token: ${{ secrets.PYPI_TOKEN }}

Matrix Testing¶

jobs:
  ci:
    uses: provide-io/ci-tooling/.github/workflows/python-ci.yml@v0.0.1
    with:
      matrix-testing: true
      os-matrix: 'ubuntu-latest,macos-latest,windows-latest'

Separate CI and Release¶

name: CI/CD

on:
  push:
    branches: [main]
    tags: ['v*']
  pull_request:

jobs:
  ci:
    uses: provide-io/ci-tooling/.github/workflows/python-ci.yml@v0.0.1
    with:
      python-version: '3.11'

  release:
    if: startsWith(github.ref, 'refs/tags/v')
    needs: ci
    uses: provide-io/ci-tooling/.github/workflows/python-release.yml@v0.0.1
    secrets:
      pypi-token: ${{ secrets.PYPI_TOKEN }}

Workflow Permissions¶

Minimal Permissions (CI)¶

permissions:
  contents: read
  pull-requests: write  # For PR comments

jobs:
  ci:
    uses: provide-io/ci-tooling/.github/workflows/python-ci.yml@v0.0.1

Release Permissions¶

permissions:
  contents: write  # For GitHub releases
  id-token: write  # For PyPI trusted publishing

jobs:
  release:
    uses: provide-io/ci-tooling/.github/workflows/python-release.yml@v0.0.1

Security Scanning Permissions¶

permissions:
  contents: read
  security-events: write  # For SARIF upload

jobs:
  ci:
    uses: provide-io/ci-tooling/.github/workflows/python-ci.yml@v0.0.1
    with:
      run-security: true

Workflow Outputs¶

Reusable workflows can provide outputs:

jobs:
  ci:
    uses: provide-io/ci-tooling/.github/workflows/python-ci.yml@v0.0.1
    with:
      python-version: '3.11'

  deploy:
    needs: ci
    runs-on: ubuntu-latest
    steps:
      - name: Deploy
        run: |
          echo "Coverage: ${{ needs.ci.outputs.coverage-percentage }}"
          echo "Version: ${{ needs.ci.outputs.package-version }}"

Secrets Management¶

Required Secrets¶

For release workflows:

secrets:
  pypi-token: ${{ secrets.PYPI_TOKEN }}
  github-token: ${{ secrets.GITHUB_TOKEN }}  # Auto-provided

For optional integrations:

secrets:
  codecov-token: ${{ secrets.CODECOV_TOKEN }}

Setting Secrets¶

Go to repository Settings → Secrets and variables → Actions
Click "New repository secret"
Add secret name and value
Reference in workflow with ${{ secrets.SECRET_NAME }}

Debugging Workflows¶

Enable Debug Logging¶

jobs:
  ci:
    uses: provide-io/ci-tooling/.github/workflows/python-ci.yml@v0.0.1
    with:
      python-version: '3.11'

env:
  ACTIONS_STEP_DEBUG: true
  ACTIONS_RUNNER_DEBUG: true

Check Workflow Logs¶

Go to Actions tab in GitHub
Click on workflow run
Expand job and step logs
Look for errors or warnings

Workflow Artifacts¶

Workflows automatically upload:

Test results (JUnit XML)
Coverage reports (XML)
Security scan results (SARIF, JSON)
Built packages (wheel, sdist)

Download from workflow run page or using:

- uses: actions/download-artifact@v4
  with:
    name: artifact-name

Performance Optimization¶

Cache Strategy¶

Workflows use caching automatically: - UV cache (~/.cache/uv) - Python packages (workenv/) - Dependency manifests (pyproject.toml hash)

Parallel Jobs¶

Workflows run jobs in parallel: - Quality checks run first - Tests run after quality passes - Security scans run parallel to tests - Performance tests run parallel (optional)

Matrix Optimization¶

jobs:
  ci:
    uses: provide-io/ci-tooling/.github/workflows/python-ci.yml@v0.0.1
    with:
      matrix-testing: true
      fail-fast: true  # Stop on first failure
      os-matrix: 'ubuntu-latest'  # Single OS for faster runs

Customization Examples¶

Custom Coverage Threshold¶

jobs:
  ci:
    uses: provide-io/ci-tooling/.github/workflows/python-ci.yml@v0.0.1
    with:
      coverage-threshold: 90

Disable Security Scanning¶

jobs:
  ci:
    uses: provide-io/ci-tooling/.github/workflows/python-ci.yml@v0.0.1
    with:
      run-security: false

Custom Source Paths¶

jobs:
  ci:
    uses: provide-io/ci-tooling/.github/workflows/python-ci.yml@v0.0.1
    with:
      source-paths: 'lib/ tests/'
      test-directory: 'spec/'

Troubleshooting¶

Workflow Not Triggering¶

Check: - Workflow file location (.github/workflows/) - Trigger conditions (on: section) - Branch protection rules - Repository permissions

Workflow Failing¶

Common issues: - Missing secrets - Insufficient permissions - Coverage threshold too high - Test failures - Build errors

Secrets Not Available¶

Ensure: - Secrets are set in repository settings - Secret names match exactly - Secrets are passed in secrets: section - Caller has access to secrets

Migration Guide¶

From Makefile to Workflows¶

Before (Makefile):

test:
    pytest tests/

quality:
    ruff check src/
    mypy src/

After (Workflow):

jobs:
  ci:
    uses: provide-io/ci-tooling/.github/workflows/python-ci.yml@v0.0.1

From Custom Workflows¶

Before (Custom):

jobs:
  test:
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
      - run: pip install -e .[dev]
      - run: pytest

After (Reusable):

jobs:
  ci:
    uses: provide-io/ci-tooling/.github/workflows/python-ci.yml@v0.0.1

Next Steps¶

python-ci.yml - CI workflow reference
python-release.yml - Release workflow reference
Actions - Individual action documentation
Quick Start - Get started quickly