_Checking_JobTemplates.yml

name: Verification of Job Templates
run-name: ${{ github.ref_type == 'tag' && github.ref_name || '' }}

on:
  push:
    # 'update/rN' carries a version branch's rewritten references; only 'Pipeline.yml' runs there.
    branches-ignore:
      - 'update/**'
    tags:
      - '**'
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: ${{ !startsWith(github.ref, 'refs/tags/') }}  # tag pushes can publish a release, so never cancel those

jobs:
  Prepare:
    uses: pyTooling/Actions/.github/workflows/PrepareJob.yml@dev

  PagesConditions:
    uses: pyTooling/Actions/.github/workflows/PrepareJob.yml@dev
    with:
      publish_pages_on: |
        # a comment line and an empty line

        default-branch
        main-branch
        development-branch
        release-branch
        release-tag
        nightly-tag
        branch=.+
        tag=.+

  CheckPagesConditions:
    name: 🔍 Check 'publish_pages' of PrepareJob
    runs-on: ubuntu-26.04
    needs:
      - PagesConditions
    steps:
      - name: Check that 'branch=.+' and 'tag=.+' match every pipeline
        env:
          PUBLISH_PAGES: ${{ needs.PagesConditions.outputs.publish_pages }}
        run: |
          printf -- 'publish_pages: %s\n' "${PUBLISH_PAGES}"
          if [[ "${PUBLISH_PAGES}" != "true" ]]; then
            printf -- "::error title=PagesConditions::Expected 'true', got '%s'.\n" "${PUBLISH_PAGES}"
            exit 1
          fi

  ConfigParams:
    uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@dev

  UnitTestingParams:
    uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
    with:
      package_name:        'myPackage'
      python_version_list: '3.11 3.12 3.13 3.14 3.15 pypy-3.11 pypy-3.12'
      disable_list:        'windows-arm:pypy-3.11 windows-arm:pypy-3.12'
      documentation_steps: 'all'

  PlatformTestingParams:
    uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
    with:
      package_name:        'myPackage'
      name:                'Platform'
      python_version_list: ''
      system_list:         'ubuntu ubuntu-arm windows windows-arm macos clang64 ucrt64'
      documentation_steps: 'none'

  AppTestingParams:
    uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
    with:
      package_name:        'myPackage'
      python_version_list: ''                # just the default Python version, but on all systems

  InstallParams:
    uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
    with:
      package_name:        'myPackage'
      python_version:      ${{ needs.UnitTestingParams.outputs.python_version }}
      python_version_list: ''
      documentation_steps: ''

  UnitTesting:
    uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@dev
    needs:
      - ConfigParams
      - UnitTestingParams
    with:
      jobs:                     ${{ needs.UnitTestingParams.outputs.python_jobs }}
      unittest_report_xml:      ${{ needs.ConfigParams.outputs.unittest_report_xml }}
      coverage_report_xml:      ${{ needs.ConfigParams.outputs.coverage_report_xml }}
      coverage_report_json:     ${{ needs.ConfigParams.outputs.coverage_report_json }}
      coverage_report_html:     ${{ needs.ConfigParams.outputs.coverage_report_html }}
      unittest_xml_artifact:    ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
      unittest_html_artifact:   ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_html }}
      coverage_sqlite_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}
      coverage_xml_artifact:    ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_xml }}
      coverage_json_artifact:   ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_json }}
      coverage_html_artifact:   ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}

  PlatformTesting:
    uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@dev
    needs:
      - ConfigParams
      - PlatformTestingParams
    with:
      jobs:                     ${{ needs.PlatformTestingParams.outputs.python_jobs }}
#      tests_directory: ""
      unittest_directory:       platform
      unittest_report_xml:      ${{ needs.ConfigParams.outputs.unittest_report_xml }}
      coverage_report_xml:      ${{ needs.ConfigParams.outputs.coverage_report_xml }}
      coverage_report_json:     ${{ needs.ConfigParams.outputs.coverage_report_json }}
      coverage_report_html:     ${{ needs.ConfigParams.outputs.coverage_report_html }}
      unittest_xml_artifact:    ${{ fromJson(needs.PlatformTestingParams.outputs.artifact_names).unittesting_xml }}
      unittest_html_artifact:   ${{ fromJson(needs.PlatformTestingParams.outputs.artifact_names).unittesting_html }}
      coverage_sqlite_artifact: ${{ fromJson(needs.PlatformTestingParams.outputs.artifact_names).codecoverage_sqlite }}
      coverage_xml_artifact:    ${{ fromJson(needs.PlatformTestingParams.outputs.artifact_names).codecoverage_xml }}
      coverage_json_artifact:   ${{ fromJson(needs.PlatformTestingParams.outputs.artifact_names).codecoverage_json }}
      coverage_html_artifact:   ${{ fromJson(needs.PlatformTestingParams.outputs.artifact_names).codecoverage_html }}

  StaticTypeCheck:
    uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@dev
    needs:
      - ConfigParams
      - UnitTestingParams
    with:
      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
      html_report:    ${{ needs.ConfigParams.outputs.typing_report_html }}
      html_artifact:  ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}

  CodeQuality:
    uses: pyTooling/Actions/.github/workflows/CheckCodeQuality.yml@dev
    needs:
      - UnitTestingParams
      - PublishTestResults  # artificial dependency to delay start when pipeline has free job resources
    with:
      python_version:    ${{ needs.UnitTestingParams.outputs.python_version }}
      package_directory: ${{ needs.UnitTestingParams.outputs.package_directory }}
      bandit:            'true'
      pylint:            'true'
      artifact:          'CodeQuality'

  DocCoverage:
    uses: pyTooling/Actions/.github/workflows/CheckDocumentation.yml@dev
    needs:
      - ConfigParams
      - UnitTestingParams
      - StaticTypeCheck     # artificial dependency to delay start when pipeline has free job resources
    with:
      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
      directory     : ${{ needs.ConfigParams.outputs.package_directory }}
#      fail_below: 70

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

  Install:
    uses: pyTooling/Actions/.github/workflows/InstallPackage.yml@dev
    needs:
      - UnitTestingParams
      - InstallParams
      - Package
    with:
      jobs:         ${{ needs.InstallParams.outputs.python_jobs }}
      wheel:        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
      package_name: ${{ needs.UnitTestingParams.outputs.package_fullname }}

  ExampleReport:
    name: 📄 Example report for the application tests
    runs-on: ubuntu-26.04
    steps:
      - name: 📄 Write an example report
        run: |
          mkdir -p report
          printf -- '%s\n' 'Report of an example job.' > report/Example.txt

      - name: 📤 Upload the example report as artifact
        uses: pyTooling/upload-artifact@v7
        with:
          name: Example-Report
          path: report/Example.txt

  AppTesting:
    uses: pyTooling/Actions/.github/workflows/ApplicationTesting.yml@dev
    needs:
      - ConfigParams
      - AppTestingParams
      - UnitTestingParams
      - Package
      - ExampleReport
    with:
      jobs:                 ${{ needs.AppTestingParams.outputs.python_jobs }}
      wheel:                ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
      artifacts_pattern:    'Example-*'
      apptest_report_xml:   ${{ needs.ConfigParams.outputs.unittest_report_xml }}
      apptest_xml_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).apptesting_xml }}

  PublishCoverageResults:
    uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@dev
    needs:
      - ConfigParams
      - UnitTestingParams
      - UnitTesting
      - PlatformTesting
    with:
      coverage_report_xml:      ${{ needs.ConfigParams.outputs.coverage_report_xml }}
      coverage_report_json:     ${{ needs.ConfigParams.outputs.coverage_report_json }}
      coverage_report_html:     ${{ needs.ConfigParams.outputs.coverage_report_html }}
      coverage_sqlite_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}
      coverage_xml_artifact:    ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_xml }}
      coverage_json_artifact:   ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_json }}
      coverage_html_artifact:   ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}
      codecov:                  true
      codacy:                   true
    secrets: inherit

  PublishTestResults:
    uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@dev
    needs:
      - ConfigParams
      - UnitTestingParams
      - UnitTesting
      - PlatformTesting
      - AppTesting
    if: ${{ !cancelled() }}  # not 'success() || failure()', because that's false if a dependency was skipped
    with:
      additional_merge_args:  '-d "--pytest=rewrite-dunder-init;reduce-depth:pytest.tests.unit;reduce-depth:pytest.tests.platform;reduce-depth:pytest.tests.app"'
      testsuite-summary-name: ${{ needs.UnitTestingParams.outputs.package_fullname }}
      merged_junit_artifact:  ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
      codecov:                true
      dorny:                  true
    secrets: inherit

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

  Documentation:
    uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@dev
    needs:
      - ConfigParams
      - UnitTestingParams
      - PublishTestResults
      - PublishCoverageResults
#      - VerifyDocs
    with:
      python_version:         ${{ needs.UnitTestingParams.outputs.python_version }}
      unittest_xml:           ${{ needs.ConfigParams.outputs.unittest_report_xml }}
      coverage_report_json:   ${{ needs.ConfigParams.outputs.coverage_report_json }}
      unittest_xml_artifact:  ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
      coverage_json_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_json }}
      html_artifact:          ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_html }}
      latex_artifact:         ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}

  IntermediateCleanUp:
    uses: pyTooling/Actions/.github/workflows/CleanupArtifacts.yml@dev
    needs:
      - UnitTestingParams
      - PublishCoverageResults
      - PublishTestResults
    with:
      json: ${{ needs.UnitTestingParams.outputs.artifact_names }}
      artifact-json-ids: >-
        codecoverage_sqlite:-*
        unittesting_xml:-*

  PDFDocumentation:
    uses: pyTooling/Actions/.github/workflows/LaTeXDocumentation.yml@dev
    needs:
      - UnitTestingParams
      - Documentation
    with:
      document:       'myPackage'
      latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
      pdf_artifact:   ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_pdf }}

  PublishToGitHubPages:
    uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@dev
    needs:
      - UnitTestingParams
      - Documentation
      - PDFDocumentation
      - PublishCoverageResults
      - StaticTypeCheck
    with:
      doc:    ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_html }}
      typing: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}

  ReleaseCheck:
    uses: pyTooling/Actions/.github/workflows/CheckReleaseVersion.yml@dev
    with:
      version:              'v99.0.0'
      package_version:      '99.0.0'
      check_pypi_duplicate: 'true'
      pypi_package:         'pyTooling'

  PublishOnPyPI:
    uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@dev
    needs:
      - UnitTestingParams
      - Package
    with:
      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
      requirements:   -r dist/requirements.txt
      artifact:       ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
      dry_run:        'true'   # 'myPackage' is a fixture - never publish it
      publish_sdist:  'false'  # as pyTooling's own pipeline does
      cleanup:        'false'  # 'ArtifactCleanUp' deletes it
    secrets: inherit

  ArtifactCleanUp:
    uses: pyTooling/Actions/.github/workflows/CleanupArtifacts.yml@dev
    needs:
      - Prepare
      - UnitTestingParams
      - PlatformTestingParams
      - UnitTesting
      - StaticTypeCheck
      - PlatformTesting
      - Documentation
      - PDFDocumentation
      - PublishTestResults
      - PublishCoverageResults
      - PublishToGitHubPages
      - Install
      - IntermediateCleanUp
    if: ${{ !cancelled() }}  # match 'CompletePipeline.yml': still clean up when an unrelated job failed
    with:
      json: ${{ needs.UnitTestingParams.outputs.artifact_names }}
      artifact-json-ids: >-
        unittesting_xml:-*
        unittesting_html:-*
        codecoverage_xml:-*
        codecoverage_json:-*
        codecoverage_html:-*
        unittesting_xml
        unittesting_html
        codecoverage_sqlite
        codecoverage_xml
        codecoverage_json
        codecoverage_html
        statictyping_html
        #apptesting_xml:-*
        documentation_html
        documentation_latex
      # The package artifact is kept on a release-tag run: 'PublishOnPyPI' consumes it and deletes it itself.
      json2:      ${{ needs.UnitTestingParams.outputs.artifact_names }}
      condition2: ${{ needs.Prepare.outputs.is_release_tag != 'true' }}
      artifact-json-ids2: >-
        package_all
      # The platform artifacts are unconditional, and both JSON slots are taken, so they are listed literally.
      others: |
        ${{ fromJson(needs.PlatformTestingParams.outputs.artifact_names).unittesting_xml }}-*
        ${{ fromJson(needs.PlatformTestingParams.outputs.artifact_names).unittesting_html }}-*
        ${{ fromJson(needs.PlatformTestingParams.outputs.artifact_names).codecoverage_xml }}-*
        ${{ fromJson(needs.PlatformTestingParams.outputs.artifact_names).codecoverage_json }}-*
        ${{ fromJson(needs.PlatformTestingParams.outputs.artifact_names).codecoverage_html }}-*