From 88ba46e2775075c7dca05454cb1c1a646567d87e Mon Sep 17 00:00:00 2001 From: Aidan Steele Date: Fri, 7 Feb 2020 15:42:34 +1100 Subject: [PATCH] Meet marketplace requirements --- README.md | 27 +++++++++++++++++++++++++++ action.yml | 33 +++------------------------------ 2 files changed, 30 insertions(+), 30 deletions(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..4932488 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +This is an action that you can run on a regular basis to clean up outdated +workflow run artifacts before their typical 90 day expiry. + +By default, all artifacts are deleted. There are options to only delete big +artifacts, artifacts of a certain age or ones with a specific name. + +Suggested usage is in a standalone workflow doc at `.github/workflows/cleanup.yml` +with the following content: + +``` +name: clean artifacts + +on: + schedule: + - cron: '0 0 * * *' + +jobs: + clean: + runs-on: ubuntu-latest + steps: + - name: cleanup + uses: glassechidna/artifact-cleaner@master + with: + minimumAge: 86400 # all artifacts at least one day old +``` + +This cleans all artifacts once a day. diff --git a/action.yml b/action.yml index a397a60..4a81e5e 100644 --- a/action.yml +++ b/action.yml @@ -1,33 +1,6 @@ -name: "GitHub Actions Artifact Cleaner" -author: "Aidan Steele @ Glass Echidna" -description: | - This is an action that you can run on a regular basis to clean up outdated - workflow run artifacts before their typical 90 day expiry. - - By default, all artifacts are deleted. There are options to only delete big - artifacts, artifacts of a certain age or ones with a specific name. - - Suggested usage is in a standalone workflow doc at `.github/workflows/cleanup.yml` - with the following content: - - ``` - name: clean artifacts - - on: - schedule: - - cron: '0 0 * * *' - - jobs: - clean: - runs-on: ubuntu-latest - steps: - - name: cleanup - uses: glassechidna/artifact-cleaner@master - with: - minimumAge: 86400 # all artifacts at least one day old - ``` - - This cleans all artifacts once a day. +name: GitHub Actions Artifact Cleaner +author: Aidan Steele @ Glass Echidna +description: Automatically clean up old artifacts from your actions branding: icon: trash-2 color: red