ArtifactCleanUp

Attention

This job template is deprecated and will be removed in r8. Use CleanupArtifacts instead, which resolves artifact names from the artifact_names JSON dictionary produced by Parameters and can delete two independently guarded sets of artifacts. The job template emits the same warning at runtime.

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

Features

• Delete artifacts from pipeline.

Behavior

1. Delete the package artifact if the current pipeline run was not a tagged run (package).

2. Delete all remaining artifacts if given as a parameter (remaining).

Job Execution

Dependencies

• GitHub: geekyeggo/delete-artifact

Instantiation

Simple Example

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

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

Complex Example

jobs:
  ArtifactCleanUp:
    uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@r8
    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

CleanupArtifacts

The replacement for this template.

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. Deprecated as well.

Parameter Summary

Goto input parameters

Parameter Name	Required	Type	Default
ubuntu_image_version	no	string	'26.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:

'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.

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:

Artifacts to be removed on every run, one artifact name per line.
Names may end in * to delete all per-matrix-job variants of an artifact.

Secrets

This job template needs no secrets.

Outputs

This job template has no output parameters.

Optimizations

This template offers no optimizations (reduced job runtime).