Skip to content
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

docs: improve README #16

Merged
merged 1 commit into from
Jan 25, 2024
Merged

docs: improve README #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 13 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,12 @@ required.
[required to delete caches](https://docs.github.com/en/rest/actions/cache?apiVersion=2022-11-28#delete-a-github-actions-cache-for-a-repository-using-a-cache-id).

```yml
name: cleanup caches by a branch
on:
pull_request:
pull_request_target:
types:
- closed
delete:

jobs:
cleanup:
Expand All @@ -30,7 +32,13 @@ jobs:
uses: 4m-mazi/souji-action@v1 # Check and specify the latest version
```

For instance, when a Pull Request created in the branch `feat/awesome-feature`
is "merged" or "closed," a workflow event is triggered and the workflow is
executed. At this time, all GitHub Actions Caches created under the merge ref
`refs/pull/{pull_request_number}/merge` are deleted.
This workflow cleans up caches for branches when they are merged(closed) or
deleted. \
This will clear the following cache:

- merge ref `refs/pull/<number>/merge`
- When a pull request is merged or closed, this workflow removes cached data
associated with the merge ref.
- branch `<branch name>`
- When a branch is deleted, this workflow deletes the cached data associated
with the branch.
Loading