Readme update for deleting caches

[t-dedah]

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.

[pallavx]

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]

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

[bishal-pdMSFT]

@t-dedah @pallavx thoughts on this?

[pallavx]

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

[t-dedah]

I am okay either way

[bishal-pdMSFT]

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

[t-dedah]

Done

[bishal-pdMSFT]

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

[t-dedah]

Sure

[pallavx]

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?

[Jimimaku]

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.

[ivan-magda]

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

[ForsakenHarmony]

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