mirror of
https://github.com/pyTooling/Actions.git
synced 2026-02-12 02:56:56 +08:00
Added more documentation sections.
This commit is contained in:
@@ -1,15 +1,34 @@
|
||||
ArtifactCleanUp
|
||||
###############
|
||||
|
||||
This job removes artifacts used to exchange data from job to job.
|
||||
|
||||
**Behavior:**
|
||||
|
||||
1. Delete the package artifact if the current pipeline run was not a tagged run.
|
||||
2. Delete all remaining artifacts if given as a parameter.
|
||||
|
||||
**Dependencies:**
|
||||
|
||||
* geekyeggo/delete-artifact@v1
|
||||
|
||||
|
||||
Instantiation
|
||||
*************
|
||||
|
||||
Simple Example
|
||||
==============
|
||||
|
||||
The simplest variant just uses the artifact name for the package.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
TBD
|
||||
jobs:
|
||||
ArtifactCleanUp:
|
||||
uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@r0
|
||||
with:
|
||||
package: Package
|
||||
|
||||
|
||||
Complex Example
|
||||
===============
|
||||
@@ -18,22 +37,53 @@ Complex Example
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
TBD
|
||||
jobs:
|
||||
ArtifactCleanUp:
|
||||
uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@r0
|
||||
needs:
|
||||
- Params
|
||||
- UnitTesting
|
||||
- BuildTheDocs
|
||||
- PublishToGitHubPages
|
||||
- PublishTestResults
|
||||
with:
|
||||
package: ${{ fromJson(needs.Params.outputs.params).artifacts.package }}
|
||||
remaining: |
|
||||
${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-ubuntu-3.9
|
||||
${{ fromJson(needs.Params.outputs.params).artifacts.unittesting }}-ubuntu-3.10
|
||||
|
||||
Template Parameters
|
||||
*******************
|
||||
|
||||
TBD 1
|
||||
=====
|
||||
Parameters
|
||||
**********
|
||||
|
||||
TBD
|
||||
package
|
||||
=======
|
||||
|
||||
TBD 1
|
||||
=====
|
||||
Artifacts to be removed on not tagged runs.
|
||||
|
||||
TBD
|
||||
+----------+----------+----------+
|
||||
| Required | Type | Default |
|
||||
+==========+==========+==========+
|
||||
| yes | string | — — — — |
|
||||
+----------+----------+----------+
|
||||
|
||||
Template Results
|
||||
****************
|
||||
remaining
|
||||
=========
|
||||
|
||||
*None*
|
||||
Artifacts to be removed unconditionally.
|
||||
|
||||
+----------+----------+----------+
|
||||
| Required | Type | Default |
|
||||
+==========+==========+==========+
|
||||
| optional | string | ``""`` |
|
||||
+----------+----------+----------+
|
||||
|
||||
Secrets
|
||||
*******
|
||||
|
||||
This job template needs no secrets.
|
||||
|
||||
Results
|
||||
*******
|
||||
|
||||
This job template has no output parameters.
|
||||
|
||||
Reference in New Issue
Block a user