Skip to content

Caching Mechanism described #9

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
WorkOfStan merged 3 commits into from
Apr 1, 2025
Merged

Caching Mechanism described #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
869fc97
Caching Mechanism described
WorkOfStan Feb 21, 2025
4a04cea
added The cache name (key) desc
WorkOfStan Feb 21, 2025
34568c5
prettier-fix:v1.1.3 seablast-action:v0.2.3
WorkOfStan Apr 1, 2025
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
4 changes: 2 additions & 2 deletions .github/workflows/polish-the-code.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ jobs:
timeout-minutes: 10
steps:
- name: Invoke the Prettier fix
uses: WorkOfStan/[email protected].1
uses: WorkOfStan/[email protected].3
with:
commit-changes: true

super-linter:
needs: prettier-fix
uses: WorkOfStan/seablast-actions/.github/workflows/[email protected].1
uses: WorkOfStan/seablast-actions/.github/workflows/[email protected].3
with:
runs-on: "ubuntu-latest"
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,14 @@ permissions:
| Output | Description |
| ------------- | ----------------------------------- |
| `branch-name` | The name of the branch created/used |

## Caching Mechanism

To optimize execution time, the `vendor` folder is cached, allowing dependencies to be reused across workflow runs. The cache key is generated based on:

- `composer.json` – to track dependency changes.
- The runner's OS and PHP version – to account for environment-specific variations.

This approach enables cache sharing across branches. However, if the `composer.json` file in the referenced branch (e.g., `dev`) changes, it's recommended to **invalidate the cache** to ensure a fresh `vendor` folder is built from scratch.

The cache name (key) is `phpcs-fix-${{ runner.os }}-PHP${{ inputs.php-version }}-vendor-${{ hashFiles('**/composer.json') }}`