IntermediateCleanUp

Attention

This job template is deprecated and will be removed in r8. Use CleanupArtifacts instead, which covers the intermediate cleanup as well as the final cleanup. CompletePipeline already instantiates CleanupArtifacts.yml for both of its cleanup jobs.

The job template emits the same warning at runtime.

Migration: the two prefix parameters become entries of artifact-json-ids using the postfix form, so the artifact names no longer need to be assembled by the caller.

# before
sqlite_coverage_artifacts_prefix: ${{ fromJson(needs.Params.outputs.artifact_names).codecoverage_sqlite }}-
xml_unittest_artifacts_prefix:    ${{ fromJson(needs.Params.outputs.artifact_names).unittesting_xml }}-

# after
json: ${{ needs.Params.outputs.artifact_names }}
artifact-json-ids: >-
  codecoverage_sqlite:-*
  unittesting_xml:-*

The IntermediateCleanUp job template is used to remove intermediate artifacts like unit test artifacts for each job variant after test results have been merged into a single file.

Instantiation

The following instantiation example creates a Params job derived from job template Parameters version @r8. It only requires a name parameter to create the artifact names.

jobs:
  IntermediateCleanUp:
    uses: pyTooling/Actions/.github/workflows/IntermediateCleanUp.yml@r8
    needs:
      - UnitTestingParams
      - PublishCoverageResults
      - PublishTestResults
    if: success() || failure()
    with:
      sqlite_coverage_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}-
      xml_unittest_artifacts_prefix:    ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-

Parameter Summary

Goto input parameters

Parameter Name	Required	Type	Default
ubuntu_image_version	no	string	`'26.04'`
sqlite_coverage_artifacts_prefix	no	string	`''`
xml_unittest_artifacts_prefix	no	string	`''`

Goto secrets

This job template needs no secrets.

Goto output parameters

This job template has no output parameters.

Input Parameters

ubuntu_image_version

Type:: string
Required:: no
Default Value:: '26.04'
Possible Values:: See actions/runner-images - Available Images for available Ubuntu image versions.
Description:: Version of the Ubuntu image used to run the job.

Note

Unfortunately, GitHub Actions has only a limited set of functions, thus, the usual Ubuntu image name like 'ubuntu-26.04' can’t be split into image name and image version.

sqlite_coverage_artifacts_prefix

Type:: string
Required:: no
Default Value:: ''
Possible Values:: Any valid artifact name including *.
Description:: Prefix for SQLite coverage artifacts to be removed.

xml_unittest_artifacts_prefix

Type:: string
Required:: no
Default Value:: ''
Possible Values:: Any valid artifact name including *.
Description:: Prefix for XML unittest artifacts to be removed.

Secrets

This job template needs no secrets.

Outputs

This job template has no output parameters.

Optimizations

This template offers no optimizations (reduced job runtime).