ArtifactCleanUp

This job removes artifacts which were used to exchange data between jobs.

Instantiation

Simple Example

The simplest variant just uses the artifact name for the package.

jobs:
  ArtifactCleanUp:
    uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@r6
    with:
      package: Package

Complex Example

jobs:
  ArtifactCleanUp:
    uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@r6
    needs:
      - Params
      - UnitTesting
      - BuildTheDocs
      - PublishToGitHubPages
      - PublishTestResults
    with:
      package: ${{ fromJson(needs.Params.outputs.artifact_names).package_all }}
      remaining: |
        ${{ fromJson(needs.Params.outputs.artifact_names).unittesting_xml }}-*

See also

IntermediateCleanUp

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

Parameter Summary

Goto input parameters

Parameter Name

Required

Type

Default

ubuntu_image_version

no

string

'24.04'

package

yes

string

— — — —

remaining

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:

'24.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-24.04' can’t be split into image name and image version.

package

Type:

string

Required:

yes

Default Value:

— — — —

Possible Values:

Multi-line string accepting any valid artifact name per line.

Description:

Artifacts to be removed on not tagged runs.

remaining

Type:

string

Required:

no

Default Value:

''

Possible Values:

Multi-line string accepting any valid artifact name per line.

Description:

Versi

Secrets

This job template needs no secrets.

Outputs

This job template has no output parameters.

Optimizations

This template offers no optimizations (reduced job runtime).