Skip to content

fix: Clarify that the example to list and delete caches on PR closure has a limit #26252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SiaraMist merged 6 commits into from
Jul 14, 2023
Merged

fix: Clarify that the example to list and delete caches on PR closure has a limit #26252

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
08efcd8
fix: Clarify that the example to list and delete caches on PR closure…
erezrokah Jun 26, 2023
7ca444e
Update caching-dependencies-to-speed-up-workflows.md
erezrokah Jun 26, 2023
aaae38e
Update caching-dependencies-to-speed-up-workflows.md
erezrokah Jun 26, 2023
aac6e5c
Update content/actions/using-workflows/caching-dependencies-to-speed-…
erezrokah Jul 12, 2023
03d6f80
Update content/actions/using-workflows/caching-dependencies-to-speed-…
SiaraMist Jul 14, 2023
1d3f82e
Merge branch 'main' into patch-1
SiaraMist Jul 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ Caches have branch scope restrictions in place, which means some caches have lim

For example, a repository could have many new pull requests opened, each with their own caches that are restricted to that branch. These caches could take up the majority of the cache storage for that repository. Once a repository has reached its maximum cache storage, the cache eviction policy will create space by deleting the oldest caches in the repository. In order to prevent cache thrashing when this happens, you can set up workflows to delete caches on a faster cadence than the cache eviction policy will. You can use the [`gh-actions-cache`](https://github.com/actions/gh-actions-cache/) CLI extension to delete caches for specific branches.

This example workflow uses `gh-actions-cache` to delete all the caches created by a branch once a pull request is closed.
This example workflow uses `gh-actions-cache` to delete up to 100 caches created by a branch once a pull request is closed.

```yaml
name: cleanup caches by a branch
Expand All @@ -356,7 +356,7 @@ jobs:
BRANCH="refs/pull/{% raw %}${{ github.event.pull_request.number }}{% endraw %}/merge"

echo "Fetching list of cache key"
cacheKeysForPR=$(gh actions-cache list -R $REPO -B $BRANCH | cut -f 1 )
cacheKeysForPR=$(gh actions-cache list -R $REPO -B $BRANCH -L 100 | cut -f 1 )

## Setting this to not fail the workflow while deleting cache keys.
set +e
Expand All @@ -370,6 +370,6 @@ jobs:
GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %}
```

Alternatively, you can use the API to programmatically delete caches on your own cadence. For more information, see "[AUTOTITLE](/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key)."
Alternatively, you can use the API to automatically list or delete all caches on your own cadence. For more information, see "[AUTOTITLE](/rest/actions/cache#about-the-cache-in-github-actions)."

{% endif %}