Pipeline.yml

name: Pipeline

on:
  push:
  workflow_dispatch:
  schedule:
    - cron: '0 0 * * 5'

jobs:
  Params:
    uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
    with:
      name: sphinx_reports
      system_list: "ubuntu"

  UnitTesting:
    uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@dev
    needs:
      - Params
    with:
      jobs: ${{ needs.Params.outputs.python_jobs }}
      artifact: ${{ fromJson(needs.Params.outputs.artifact_names).unittesting_xml }}

  Coverage:
    uses: pyTooling/Actions/.github/workflows/CoverageCollection.yml@dev
    needs:
      - Params
    with:
      python_version: ${{ needs.Params.outputs.python_version }}
      artifact: ${{ fromJson(needs.Params.outputs.artifact_names).codecoverage_html }}
    secrets:
      codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }}

  StaticTypeCheck:
    uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@dev
    needs:
      - Params
    with:
      python_version: ${{ needs.Params.outputs.python_version }}
      commands: |
        mypy --html-report htmlmypy -p sphinx-reports
      html_report: 'htmlmypy'
      html_artifact: ${{ fromJson(needs.Params.outputs.artifact_names).statictyping_html }}

  PublishTestResults:
    uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@dev
    needs:
      - UnitTesting

  Package:
    uses: pyTooling/Actions/.github/workflows/Package.yml@dev
    needs:
      - Params
      - Coverage
    with:
      python_version: ${{ needs.Params.outputs.python_version }}
      artifact: ${{ fromJson(needs.Params.outputs.artifact_names).package_all }}

  AppTesting:
    uses: pyTooling/Actions/.github/workflows/ApplicationTesting.yml@dev
    needs:
      - Params
      - Package
    with:
      jobs: ${{ needs.Params.outputs.python_jobs }}
      wheel: ${{ fromJson(needs.Params.outputs.artifact_names).package_all }}
      artifact: ${{ fromJson(needs.Params.outputs.artifact_names).apptesting_xml }}

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

  PublishOnPyPI:
    uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@dev
    if: startsWith(github.ref, 'refs/tags')
    needs:
      - Params
      - Release
      - Package
    with:
      python_version: ${{ needs.Params.outputs.python_version }}
      requirements: -r dist/requirements.txt
      artifact: ${{ fromJson(needs.Params.outputs.artifact_names).package_all }}
    secrets:
      PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}

#  VerifyDocs:
#    uses: pyTooling/Actions/.github/workflows/VerifyDocs.yml@dev
#    needs:
#      - Params
#    with:
#      python_version: ${{ needs.Params.outputs.python_version }}

  BuildTheDocs:
    uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@dev
    needs:
      - Params
#      - VerifyDocs
    with:
      artifact: ${{ fromJson(needs.Params.outputs.artifact_names).documentation_html }}

  PublishToGitHubPages:
    uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@dev
    needs:
      - Params
      - BuildTheDocs
      - Coverage
      - StaticTypeCheck
    with:
      doc: ${{ fromJson(needs.Params.outputs.artifact_names).documentation_html }}
      coverage: ${{ fromJson(needs.Params.outputs.artifact_names).codecoverage_html }}
      typing: ${{ fromJson(needs.Params.outputs.artifact_names).statictyping_html }}

  ArtifactCleanUp:
    uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@dev
    needs:
      - Params
      - UnitTesting
      - AppTesting
      - Coverage
      - StaticTypeCheck
      - BuildTheDocs
      - PublishToGitHubPages
      - PublishTestResults
    with:
      package: ${{ fromJson(needs.Params.outputs.artifact_names).package_all }}
      remaining: |
        ${{ fromJson(needs.Params.outputs.artifact_names).unittesting_xml }}-*
        ${{ fromJson(needs.Params.outputs.artifact_names).apptesting_xml }}
        ${{ fromJson(needs.Params.outputs.artifact_names).codecoverage_html }}
        ${{ fromJson(needs.Params.outputs.artifact_names).statictyping_html }}
        ${{ fromJson(needs.Params.outputs.artifact_names).documentation_html }}