From 6cd80eb895da7f90e74a74a30546d31a62fb28c7 Mon Sep 17 00:00:00 2001 From: Mogyuchi Date: Sat, 3 Feb 2024 18:00:02 +0900 Subject: [PATCH] docs: document why section --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 5d1f456..e49ee06 100644 --- a/README.md +++ b/README.md @@ -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