Actions/ExamplePipeline.yml

name: Unit Testing, Coverage Collection, Package, Release, Documentation and Publish

on:
  workflow_dispatch:

jobs:

  # This job is a workaround for global variables
  # See https://github.com/actions/runner/issues/480
  Params:
    uses: pyTooling/Actions/.github/workflows/Params.yml@main
    with:
      name: ToolName
      # Optional
      python_version: '3.10'
      python_version_list: '3.8 3.9 3.10'

  UnitTesting:
    uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@main
    needs:
      - Params
    with:
      jobs: ${{ needs.Params.outputs.python_jobs }}
      # Optional
      requirements: '-r tests/requirements.txt'
      artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}

  Coverage:
    uses: pyTooling/Actions/.github/workflows/CoverageCollection.yml@main
    needs:
      - Params
    with:
      artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.coverage }}
      # Optional
      python_version: ${{ fromJson(needs.Params.outputs.params).python_version }}
      requirements: '-r tests/requirements.txt'
    secrets:
      codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }}

  StaticTypeCheck:
    uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@main
    needs:
      - Params
    with:
      commands: mypy --html-report htmlmypy -p ToolName
      artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.typing }}
      # Optional
      python_version: ${{ fromJson(needs.Params.outputs.params).python_version }}
      requirements: '-r tests/requirements.txt'
      report: 'htmlmypy'

  Package:
    uses: pyTooling/Actions/.github/workflows/Package.yml@main
    needs:
      - Params
      - Coverage
    with:
      artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.package }}
      # Optional
      python_version: ${{ fromJson(needs.Params.outputs.params).python_version }}
      requirements: 'wheel'

  Release:
    uses: pyTooling/Actions/.github/workflows/Release.yml@main
    if: startsWith(github.ref, 'refs/tags')
    needs:
      - UnitTesting
      - Coverage
      - StaticTypeCheck
      - Package

  PublishOnPyPI:
    uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@main
    if: startsWith(github.ref, 'refs/tags')
    needs:
      - Params
      - Release
      - Package
    with:
      artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.package }}
      # Optional
      python_version: ${{ fromJson(needs.Params.outputs.params).python_version }}
      requirements: 'wheel twine'
    secrets:
      PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}

  VerifyDocs:
    uses: pyTooling/Actions/.github/workflows/VerifyDocs.yml@main
    needs:
      - Params
    with:
      # Optional
      python_version: ${{ fromJson(needs.Params.outputs.params).python_version }}

  BuildTheDocs:
    uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@main
    needs:
      - Params
      - VerifyDocs
    with:
      artifact: ${{ fromJson(needs.Params.outputs.params).artifacts.doc }}

  PublishToGitHubPages:
    uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@main
    needs:
      - Params
      - BuildTheDocs
      - Coverage
      - StaticTypeCheck
    with:
      doc: ${{ fromJson(needs.Params.outputs.params).artifacts.doc }}
      # Optional
      coverage: ${{ fromJson(needs.Params.outputs.params).artifacts.coverage }}
      typing: ${{ fromJson(needs.Params.outputs.params).artifacts.typing }}

  ArtifactCleanUp:
    uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@main
    needs:
      - Params
      - Coverage
      - StaticTypeCheck
      - BuildTheDocs
      - PublishToGitHubPages
    with:
      package: ${{ fromJson(needs.Params.outputs.params).artifacts.package }}
      remaining: |
        ${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-*
        ${{ fromJson(needs.Params.outputs.params).artifacts.coverage }}
        ${{ fromJson(needs.Params.outputs.params).artifacts.typing }}
        ${{ fromJson(needs.Params.outputs.params).artifacts.doc }}