Skip to content

Commit

Permalink
docs: document why section
Browse files Browse the repository at this point in the history
  • Loading branch information
Mogyuchi committed Feb 3, 2024
1 parent cacf78d commit 6cd80eb
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ Souji Action is a GitHub Action that deletes all GitHub Actions Caches related
to the context of the triggered workflow event, without any configuration
required.

# Why

GitHub Actions Caches have
[branch scope restriction](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache)
in place. This means that there are caches that will never be restored in the
future. This action allows you to easily delete such caches.

## Usage

`actions:write` permission is
Expand Down

0 comments on commit 6cd80eb

Please sign in to comment.