Delete Branch Artifacts

This Action deletes all artifacts of workflow runs on a specific branch. For example it can be used to delete all artifacts that were created during a PR, after that PR was merged or closed.

Inputs

github-token (Required)

Github token used for deleting artifacts. To use the key provided by the GitHub action runner, use ${{ secrets.GITHUB_TOKEN }}.

branch (Optional)

The branch on which all workflow run artifacts should be deleted. Only needed if you do not want to delete artifacts on ${GITHUB_HEAD_REF} for PRs.

Example usage

Delete artifacts of all workflow runs on the head branch of a PR when that PR is closed or merged.

name: PR closed
 on: 
   pull_request:
     types: [closed]

 jobs:
   remove-artifacts:
     runs-on: ubuntu-latest
     steps:
       - uses: bamac-group/[email protected]
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}

Development

1. Install the dependencies

npm install

2. Write code and tests

3. Run the tests ✔️

$ npm test

 PASS  ./index.test.js
  ✓ throws invalid number (3ms)
  ✓ wait 500 ms (504ms)
  ✓ test runs (95ms)
...

4. Package for distribution and release

GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules.

Actions are run from GitHub repos. Packaging the action will create a packaged action in the dist folder.

npm run all
npm --no-git-tag-version version X.X.X
git add dist package*json
git commit -a -m "release: vX.X.X"
git tag vX.X.X
git push

TODO

• add more tests