Cleanup after build

Cleanup the work directory for self hosted runners after they finish building.

Example usage

- uses: mickem/clean-after-action@v1

It is important that this is run before any caching tasks as cleanups are run in reverse order (and you do not want to cleanup before the caching is saved).

A more full example:

jobs:
  build:
    runs-on: onprem
    steps:
    - uses: mickem/clean-after-action@v1
    - uses: actions/checkout@v2
    - uses: actions/cache@v2
    # ....

Inputs

keepGit

Set this to true to prevent the .git folder to be deleted.

- uses: mickem/clean-after-action@v1
  with:
    keepGit: true

What about docker actions?

If you use docker actions files will be created by "root" and this action will fail to delete generated files.

This can be solved by forcing docker containers to run as the same user as the user which runs your self hosted runner. To do this you can use the user-remap feature in docker.

Motivation

There are a number of other actions which "solves this problem" by deleting files as the action runs (instead of as a cleanup action). The main problem with running clean up as a build step is that it will run "before other cleanup steps". This will effectively break things like caching and similar things which require files to be left when their cleanup runs.

A similar argument can be made for running cleanup before you build, this means the disk will eventually become full as more and more projects build.