workflow.yml

# Main workflow

name: CI

on:
    push:
      branches:
      - '*'
      - '!badges'
  
jobs:

    # Stage 1: Validate Source
    test:
        name: Test the package
        uses: ./.github/workflows/test.yml

    mypy:
        name: Static Type Check the package
        uses: ./.github/workflows/mypy.yml

    ruff:
        name: Lint the package
        uses: ./.github/workflows/ruff.yml

    build:
        name: Build the package
        uses: ./.github/workflows/build.yml
    
    # Stage 2: Release Packages and Build documentation
    pypi:
        if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
        uses: ./.github/workflows/pypi.yml
        needs:
            - test
            - mypy
            - ruff
            - build
        permissions:
            id-token: write

    github:
        if: startsWith(github.ref, 'refs/tags/')  # only publish to github on tag pushes
        uses: ./.github/workflows/github.yml
        needs:
            - test
            - mypy
            - ruff
            - build
        permissions:
            contents: write  # IMPORTANT: mandatory for making GitHub Releases
            id-token: write  # IMPORTANT: mandatory for sigstore
      
    docs:
        if:  # build docs if pushing to main or releasing
            contains('refs/heads/main refs/tags', github.ref)
        uses: ./.github/workflows/docs.yml
        needs:
            - test
            - mypy
            - ruff
            - build
        permissions:
            contents: write  # IMPORTANT: mandatory for making GitHub Releases