Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Readme update for deleting caches#981

Merged
t-dedah merged 9 commits intomainfrom
t-dedah/cache-eviction
Nov 21, 2022
Merged

Readme update for deleting caches#981
t-dedah merged 9 commits intomainfrom
t-dedah/cache-eviction

Conversation

@t-dedah
Copy link
Contributor

@t-dedah t-dedah commented Nov 13, 2022

Description

This PR adds a Deleting cache section in readme to add workflow for automating deletion process of caches created for pull requests.

Motivation and Context

Issue - https://github.com/github/c2c-actions-cats/issues/749
ADR - https://github.com/github/c2c-actions/blob/16b328cd311a04402a2ea003444674eaa5b96701/docs/teams/platform/adrs/artifact-cache/3901-branch-based-cache-eviction.md

How Has This Been Tested?

I have tested the workflow on my personal repos

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (add or update README or docs)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@t-dedah t-dedah requested a review from a team as a code owner November 13, 2022 21:43
kotewar
kotewar reviewed Nov 14, 2022
View reviewed changes
pallavx
pallavx reviewed Nov 14, 2022
View reviewed changes
Copy link
Contributor

@pallavx pallavx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

Is it possible (and a good idea?) to add another sample indicating how to delete cache for a specific PR?

bishal-pdMSFT
bishal-pdMSFT reviewed Nov 16, 2022
View reviewed changes
bishal-pdMSFT
bishal-pdMSFT reviewed Nov 16, 2022
View reviewed changes
bishal-pdMSFT
bishal-pdMSFT reviewed Nov 16, 2022
View reviewed changes
bishal-pdMSFT
bishal-pdMSFT reviewed Nov 16, 2022
View reviewed changes
bishal-pdMSFT
bishal-pdMSFT reviewed Nov 16, 2022
View reviewed changes
bishal-pdMSFT
bishal-pdMSFT reviewed Nov 16, 2022
View reviewed changes
bishal-pdMSFT
bishal-pdMSFT reviewed Nov 16, 2022
View reviewed changes
bishal-pdMSFT
bishal-pdMSFT reviewed Nov 16, 2022
View reviewed changes
bishal-pdMSFT
bishal-pdMSFT reviewed Nov 16, 2022
View reviewed changes
bishal-pdMSFT
bishal-pdMSFT reviewed Nov 16, 2022
View reviewed changes
README.md
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```

## Known practices and workarounds
Copy link
Contributor

@bishal-pdMSFT bishal-pdMSFT Nov 16, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should move the new section to workarounds.md and leave a cross ref below. And probably rename to tips-and-workarounds.md

Copy link
Contributor

@bishal-pdMSFT bishal-pdMSFT Nov 17, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@t-dedah @pallavx thoughts on this?

Copy link
Contributor

@pallavx pallavx Nov 17, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can be done, seems like a good use-case that can be linked from Known practices and workarounds

Copy link
Contributor Author

@t-dedah t-dedah Nov 17, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am okay either way

Copy link
Contributor

@bishal-pdMSFT bishal-pdMSFT Nov 17, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am in favour as this can be the practice in readme to put any tips in separate file..

Copy link
Contributor Author

@t-dedah t-dedah Nov 17, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

bishal-pdMSFT
bishal-pdMSFT reviewed Nov 17, 2022
View reviewed changes
bishal-pdMSFT
bishal-pdMSFT reviewed Nov 17, 2022
View reviewed changes
README.md Outdated
echo "Fetching list of cache key"
cacheKeysForPR=$(gh actions-cache list -R $REPO -B $BRANCH | cut -f 1 )

set +e
Copy link
Contributor

@bishal-pdMSFT bishal-pdMSFT Nov 17, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a comment for this. I assume this is useful in case deleting a cache fails.

Copy link
Contributor Author

@t-dedah t-dedah Nov 17, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure

@pallavx
Copy link
Contributor

pallavx commented Nov 17, 2022

Looks good to me.

Is it possible (and a good idea?) to add another sample indicating how to delete cache for a specific PR?

IMO, we should have 2 examples

  1. Delete caches for a given branch (this is being done in the latest commit)
  2. Delete caches for all PR branches (this was included in the first iteration, but has now been removed)

These 2 seems like common customer use-cases and guiding examples for these will help.

@bishal-pdMSFT @pdotl opinions on this?

@t-dedah t-dedah mentioned this pull request Nov 20, 2022
Merged
@t-dedah t-dedah merged commit 6babf20 into main Nov 21, 2022
@Jimimaku
Copy link

Jimimaku commented Nov 22, 2022 •
edited
Loading

Beschreibung

Diese PR fügt einen Abschnitt in der Readme-Datei hinzu, um einen Workflow für die Automatisierung des Löschprozesses von Caches hinzuzufügen, die für Pull-Anforderungen erstellt wurden.Deleting cache

Motivation und Kontext

Problem -https://github.com/github/c2c-actions-cats/issues/749ADR -https://github.com/github/c2c-actions/blob/16b328cd311a04402a2ea003444674eaa5b96701/docs/teams/platform/adrs/artifact-cache/3901-branch-based-cache-eviction.md

Wie wurde das getestet?

Ich habe den Workflow auf meinen persönlichen Repos getestet

Screenshots (falls zutreffend):

Arten von Änderungen

  • Bugfix (geschützte Änderung, die ein Problem behebt)
  • Neue Funktion (geschützte Änderung, die Funktionalität hinzufügt)
  • Wichtige Änderung (Korrektur oder Feature, das zu einer Änderung der vorhandenen Funktionalität führen würde)
  • Dokumentation (README oder Dokumente hinzufügen oder aktualisieren)

Prüfliste:

  • Mein Code folgt dem Codestil dieses Projekts.
  • Meine Änderung erfordert eine Änderung der Dokumentation.
  • Ich habe die Dokumentation entsprechend aktualisiert.
  • Ich habe dasDokument CONTRIBUTINGgelesen.
  • Ich habe Tests hinzugefügt, um meine Änderungen abzudecken.
  • Alle neuen und bestehenden Tests bestanden.

aguschin referenced this pull request in iterative/gto Dec 21, 2022
@renovate
chore(deps): update actions/cache action to v3.2.0 (#322)
97ac17b 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [actions/cache](https://togithub.com/actions/cache) | action | minor |
`v3.0.11` -> `v3.2.0` |

---

### Release Notes

<details>
<summary>actions/cache</summary>

### [`v3.2.0`](https://togithub.com/actions/cache/releases/tag/v3.2.0)

[Compare
Source](https://togithub.com/actions/cache/compare/v3.0.11...v3.2.0)

##### What's Changed

- fix wrong timeout env var key in README.md by
[@&#8203;walterddr](https://togithub.com/walterddr) in
[https://github.com/actions/cache/pull/959](https://togithub.com/actions/cache/pull/959)
- Updated release doc with correct env variable by
[@&#8203;kotewar](https://togithub.com/kotewar) in
[https://github.com/actions/cache/pull/960](https://togithub.com/actions/cache/pull/960)
- Create pull_request_template.md by
[@&#8203;pdotl](https://togithub.com/pdotl) in
[https://github.com/actions/cache/pull/963](https://togithub.com/actions/cache/pull/963)
- Update README with clearer info about cache-hit and its value by
[@&#8203;kotewar](https://togithub.com/kotewar) in
[https://github.com/actions/cache/pull/961](https://togithub.com/actions/cache/pull/961)
- Change datadog/squid to Ubuntu/squid in CI check by
[@&#8203;bishal-pdMSFT](https://togithub.com/bishal-pdMSFT) in
[https://github.com/actions/cache/pull/976](https://togithub.com/actions/cache/pull/976)
- Add more details to version section in readme by
[@&#8203;bishal-pdMSFT](https://togithub.com/bishal-pdMSFT) in
[https://github.com/actions/cache/pull/971](https://togithub.com/actions/cache/pull/971)
- Update hashFiles documentation reference by
[@&#8203;asaf400](https://togithub.com/asaf400) in
[https://github.com/actions/cache/pull/979](https://togithub.com/actions/cache/pull/979)
- Updated link for cache segment download info by
[@&#8203;kotewar](https://togithub.com/kotewar) in
[https://github.com/actions/cache/pull/986](https://togithub.com/actions/cache/pull/986)
- Readme update for deleting caches by
[@&#8203;t-dedah](https://togithub.com/t-dedah) in
[https://github.com/actions/cache/pull/981](https://togithub.com/actions/cache/pull/981)
- Add oncall logic to assign issues and PRs by
[@&#8203;vsvipul](https://togithub.com/vsvipul) in
[https://github.com/actions/cache/pull/997](https://togithub.com/actions/cache/pull/997)
- Bump minimatch from 3.0.4 to 3.1.2 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/actions/cache/pull/998](https://togithub.com/actions/cache/pull/998)
- Revert "Bump minimatch from 3.0.4 to 3.1.2" by
[@&#8203;vsvipul](https://togithub.com/vsvipul) in
[https://github.com/actions/cache/pull/1005](https://togithub.com/actions/cache/pull/1005)
- Fix npm vulnerability by
[@&#8203;Phantsure](https://togithub.com/Phantsure) in
[https://github.com/actions/cache/pull/1007](https://togithub.com/actions/cache/pull/1007)
- refactor: Use early return pattern to avoid nested conditions by
[@&#8203;jongwooo](https://togithub.com/jongwooo) in
[https://github.com/actions/cache/pull/1013](https://togithub.com/actions/cache/pull/1013)
- Use cache in check-dist.yml by
[@&#8203;jongwooo](https://togithub.com/jongwooo) in
[https://github.com/actions/cache/pull/1004](https://togithub.com/actions/cache/pull/1004)
- chore: Use built-in cache action to cache dependencies by
[@&#8203;jongwooo](https://togithub.com/jongwooo) in
[https://github.com/actions/cache/pull/1014](https://togithub.com/actions/cache/pull/1014)
- Updated node example by
[@&#8203;t-dedah](https://togithub.com/t-dedah) in
[https://github.com/actions/cache/pull/1008](https://togithub.com/actions/cache/pull/1008)
- Fix: Node npm doc example by
[@&#8203;apascualm](https://togithub.com/apascualm) in
[https://github.com/actions/cache/pull/1026](https://togithub.com/actions/cache/pull/1026)
- docs: fix an invalid link in workarounds.md by
[@&#8203;teatimeguest](https://togithub.com/teatimeguest) in
[https://github.com/actions/cache/pull/929](https://togithub.com/actions/cache/pull/929)
- General Availability release for granular cache by
[@&#8203;kotewar](https://togithub.com/kotewar) in
[https://github.com/actions/cache/pull/1035](https://togithub.com/actions/cache/pull/1035)
More details here on
[beta](https://togithub.com/actions/cache/discussions/1020) release.

##### New Contributors

- [@&#8203;walterddr](https://togithub.com/walterddr) made their first
contribution in
[https://github.com/actions/cache/pull/959](https://togithub.com/actions/cache/pull/959)
- [@&#8203;asaf400](https://togithub.com/asaf400) made their first
contribution in
[https://github.com/actions/cache/pull/979](https://togithub.com/actions/cache/pull/979)
- [@&#8203;jongwooo](https://togithub.com/jongwooo) made their first
contribution in
[https://github.com/actions/cache/pull/1013](https://togithub.com/actions/cache/pull/1013)
- [@&#8203;apascualm](https://togithub.com/apascualm) made their first
contribution in
[https://github.com/actions/cache/pull/1026](https://togithub.com/actions/cache/pull/1026)
- [@&#8203;teatimeguest](https://togithub.com/teatimeguest) made their
first contribution in
[https://github.com/actions/cache/pull/929](https://togithub.com/actions/cache/pull/929)

**Full Changelog**: actions/cache@v3...v3.2.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://app.renovatebot.com/dashboard#github/iterative/gto).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC42Ni4xIiwidXBkYXRlZEluVmVyIjoiMzQuNjYuMSJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@mikelane mikelane mentioned this pull request Dec 22, 2022
Merged
ivan-magda
ivan-magda reviewed Dec 22, 2022
View reviewed changes
tips-and-workarounds.md
gh extension install actions/gh-actions-cache

REPO=${{ github.repository }}
BRANCH=${{ github.ref }}
Copy link

@ivan-magda ivan-magda Dec 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it’s better to use github.head_ref to get the current branch name of the PR. github.ref will return the parent branch name.

https://docs.github.com/en/actions/learn-github-actions/contexts#github-context

Copy link

@ForsakenHarmony ForsakenHarmony Jan 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

github.base_ref would be the parent branch, github.ref is the merge branch

estahn pushed a commit to estahn/k8s-image-swapper that referenced this pull request Jan 1, 2023
@semantic-release-bot
chore(release): 1.4.0 [skip ci]
0ddfc7b 
## [1.4.0](v1.3.3...v1.4.0) (2023-01-01)

### 👷 Build System

* **deps-dev:** Bump @semantic-release/changelog from 6.0.1 to 6.0.2 ([#404](#404)) ([ee56dbc](ee56dbc)), closes [#276](#276) [#276](#276) [#272](#272) [#275](#275) [#273](#273) [#274](#274) [#271](#271) [#270](#270) [#269](#269) [#268](#268) [#267](#267)

### 🎉 Features

* add custom tags to created ECR repositories ([#191](#191)) ([9849df2](9849df2))

### 📝 Documentation

* fix indentation ([b00c57e](b00c57e))

### ⬆️ Dependencies

* **deps:** Bump actions/cache from 3.0.11 to 3.2.1 ([#417](#417)) ([7e7eb8f](7e7eb8f)), closes [actions/cache#1039](actions/cache#1039) [actions/cache#1023](actions/cache#1023) [actions/cache#959](actions/cache#959) [actions/cache#960](actions/cache#960) [actions/cache#963](actions/cache#963) [actions/cache#961](actions/cache#961) [actions/cache#976](actions/cache#976) [actions/cache#971](actions/cache#971) [actions/cache#979](actions/cache#979) [actions/cache#986](actions/cache#986) [actions/cache#981](actions/cache#981) [actions/cache#997](actions/cache#997) [actions/cache#998](actions/cache#998) [actions/cache#1005](actions/cache#1005) [actions/cache#1007](actions/cache#1007) [actions/cache#1013](actions/cache#1013) [actions/cache#1004](actions/cache#1004) [actions/cache#1014](actions/cache#1014) [actions/cache#1008](actions/cache#1008) [actions/cache#1026](actions/cache#1026) [actions/cache#929](actions/cache#929) [actions/cache#1035](actions/cache#1035) [actions/cache#959](actions/cache#959) [actions/cache#979](actions/cache#979) [actions/cache#1013](actions/cache#1013) [actions/cache#1026](actions/cache#1026) [actions/cache#929](actions/cache#929) [actions/cache#1006](actions/cache#1006) [#1023](#1023) [#1039](https://github.com/estahn/k8s-image-swapper/issues/1039) [#1035](https://github.com/estahn/k8s-image-swapper/issues/1035) [#929](#929) [#1026](https://github.com/estahn/k8s-image-swapper/issues/1026) [#1008](#1008) [#1014](#1014) [#1004](#1004)
* **deps:** Bump actions/setup-python from 4.3.0 to 4.3.1 ([#406](#406)) ([16da762](16da762)), closes [actions/setup-python#559](actions/setup-python#559) [actions/setup-python#511](actions/setup-python#511) [actions/setup-python#558](actions/setup-python#558) [#559](#559) [#558](#558) [#549](#549) [#546](#546) [#545](#545) [#535](#535) [#510](#510) [#511](#511) [#520](#520)
* **deps:** Bump actions/setup-python from 4.3.1 to 4.4.0 ([#418](#418)) ([77872f8](77872f8)), closes [actions/setup-python#566](actions/setup-python#566) [#567](#567) [#569](#569) [#566](#566)
* **deps:** Bump github.com/aws/aws-sdk-go from 1.44.146 to 1.44.152 ([#403](#403)) ([9db51fd](9db51fd)), closes [#4652](https://github.com/estahn/k8s-image-swapper/issues/4652) [#4650](https://github.com/estahn/k8s-image-swapper/issues/4650) [#4648](https://github.com/estahn/k8s-image-swapper/issues/4648) [#4647](https://github.com/estahn/k8s-image-swapper/issues/4647) [#4646](https://github.com/estahn/k8s-image-swapper/issues/4646) [#4644](https://github.com/estahn/k8s-image-swapper/issues/4644) [#4639](https://github.com/estahn/k8s-image-swapper/issues/4639)
* **deps:** Bump github.com/aws/aws-sdk-go from 1.44.152 to 1.44.157 ([#411](#411)) ([2188432](2188432)), closes [#4658](https://github.com/estahn/k8s-image-swapper/issues/4658) [#4657](https://github.com/estahn/k8s-image-swapper/issues/4657) [#4656](https://github.com/estahn/k8s-image-swapper/issues/4656) [#4654](https://github.com/estahn/k8s-image-swapper/issues/4654) [#4653](https://github.com/estahn/k8s-image-swapper/issues/4653)
* **deps:** Bump github.com/aws/aws-sdk-go from 1.44.157 to 1.44.162 ([#415](#415)) ([f70fcd9](f70fcd9)), closes [#4666](https://github.com/estahn/k8s-image-swapper/issues/4666) [#4665](https://github.com/estahn/k8s-image-swapper/issues/4665) [#4663](https://github.com/estahn/k8s-image-swapper/issues/4663) [#4661](https://github.com/estahn/k8s-image-swapper/issues/4661) [#4660](https://github.com/estahn/k8s-image-swapper/issues/4660)
* **deps:** Bump github.com/aws/aws-sdk-go from 1.44.162 to 1.44.167 ([#419](#419)) ([f8b91fe](f8b91fe)), closes [#4671](https://github.com/estahn/k8s-image-swapper/issues/4671) [#4670](https://github.com/estahn/k8s-image-swapper/issues/4670) [#4669](https://github.com/estahn/k8s-image-swapper/issues/4669) [#4668](https://github.com/estahn/k8s-image-swapper/issues/4668) [#4667](https://github.com/estahn/k8s-image-swapper/issues/4667)
* **deps:** Bump github.com/gruntwork-io/terratest from 0.41.3 to 0.41.4 ([#402](#402)) ([16dde07](16dde07)), closes [#1208](https://github.com/estahn/k8s-image-swapper/issues/1208)
* **deps:** Bump github.com/gruntwork-io/terratest from 0.41.4 to 0.41.6 ([#409](#409)) ([9fc87df](9fc87df)), closes [#1214](https://github.com/estahn/k8s-image-swapper/issues/1214) [#1198](https://github.com/estahn/k8s-image-swapper/issues/1198)
* **deps:** Bump github.com/gruntwork-io/terratest from 0.41.6 to 0.41.7 ([#420](#420)) ([9ab97f2](9ab97f2)), closes [gruntwork-io/terratest#1217](gruntwork-io/terratest#1217) [#1217](https://github.com/estahn/k8s-image-swapper/issues/1217)
* **deps:** Bump goreleaser/goreleaser-action from 3.1.0 to 4.1.0 ([#414](#414)) ([e963ba1](e963ba1)), closes [goreleaser/goreleaser-action#382](goreleaser/goreleaser-action#382) [goreleaser/goreleaser-action#366](goreleaser/goreleaser-action#366) [goreleaser/goreleaser-action#379](goreleaser/goreleaser-action#379) [goreleaser/goreleaser-action#383](goreleaser/goreleaser-action#383) [goreleaser/goreleaser-action#366](goreleaser/goreleaser-action#366) [goreleaser/goreleaser-action#379](goreleaser/goreleaser-action#379) [goreleaser/goreleaser-action#370](goreleaser/goreleaser-action#370) [#374](#374) [#372](#372) [#373](#373) [#383](#383) [#366](#366) [#382](#382) [#370](#370)
* **deps:** Bump k8s.io/api from 0.25.4 to 0.26.0 ([#407](#407)) ([d13bf5e](d13bf5e)), closes [#111023](https://github.com/estahn/k8s-image-swapper/issues/111023) [#113375](https://github.com/estahn/k8s-image-swapper/issues/113375) [#113186](https://github.com/estahn/k8s-image-swapper/issues/113186)
* **deps:** Bump k8s.io/client-go from 0.25.4 to 0.26.0 ([#410](#410)) ([bcc56b5](bcc56b5)), closes [#113797](https://github.com/estahn/k8s-image-swapper/issues/113797) [#111023](https://github.com/estahn/k8s-image-swapper/issues/111023) [#113826](https://github.com/estahn/k8s-image-swapper/issues/113826) [#113375](https://github.com/estahn/k8s-image-swapper/issues/113375)
@ForsakenHarmony ForsakenHarmony mentioned this pull request Jan 10, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lvpx lvpx Awaiting requested review from lvpx

@kotewar kotewar Awaiting requested review from kotewar

@pallavx pallavx Awaiting requested review from pallavx

3 more reviewers

@ivan-magda ivan-magda ivan-magda left review comments

@ForsakenHarmony ForsakenHarmony ForsakenHarmony left review comments

@bishal-pdMSFT bishal-pdMSFT bishal-pdMSFT approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@t-dedah @pallavx @Jimimaku @bishal-pdMSFT @ivan-magda @ForsakenHarmony @lvpx @kotewar

Comments