Skip to content

Commit 38f25d2

Browse files
jrfnlgrogy
authored andcommitted
GH Actions: bust the cache semi-regularly
Caches used in GH Actions do not get updated, they can only be replaced by a different cache with a different cache key. Now the predefined Composer install action this repo is using already creates a pretty comprehensive cache key: > `ramsey/composer-install` will auto-generate a cache key which is composed of the following elements: > * The OS image name, like `ubuntu-latest`. > * The exact PHP version, like `8.1.11`. > * The options passed via `composer-options`. > * The dependency version setting as per `dependency-versions`. > * The working directory as per `working-directory`. > * A hash of the `composer.json` and/or `composer.lock` files. This means that aside from other factors, the cache will always be busted when changes are made to the (committed) `composer.json` or the `composer.lock` file (if the latter exists in the repo). For packages running on recent versions of PHP, it also means that the cache will automatically be busted once a month when a new PHP version comes out. ### The problem For runs on older PHP versions which don't receive updates anymore, the cache will not be busted via new PHP version releases, so effectively, the cache will only be busted when a change is made to the `composer.json`/`composer.lock` file - which may not happen that frequently on low-traffic repos. But... packages _in use_ on those older PHP versions - especially dependencies of declared dependencies - may still release new versions and those new versions will not exist in the cache and will need to be downloaded each time the action is run and over time the cache gets less and less relevant as more and more packages will need to be downloaded for each run. ### The solution To combat this issue, a new `custom-cache-suffix` option has been added to the Composer install action in version 2.2.0. This new option allows for providing some extra information to add to the cache key, which allows for busting the cache based on your own additional criteria. This commit implements the use of this `custom-cache-suffix` option for all relevant workflows in this repo. Refs: * https://github.com/ramsey/composer-install/#custom-cache-suffix * https://github.com/ramsey/composer-install/releases/tag/2.2.0
1 parent 540e642 commit 38f25d2

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

.github/workflows/cs.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ jobs:
3232
# @link https://github.com/marketplace/actions/install-composer-dependencies
3333
- name: Install Composer dependencies
3434
uses: "ramsey/composer-install@v2"
35+
with:
36+
# Bust the cache at least once a month - output format: YYYY-MM.
37+
custom-cache-suffix: $(date -u "+%Y-%m")
3538

3639
- name: Check PHP code style
3740
id: phpcs

.github/workflows/test.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,17 @@ jobs:
6262
- name: Install Composer dependencies - normal
6363
if: ${{ matrix.experimental == false }}
6464
uses: "ramsey/composer-install@v2"
65+
with:
66+
# Bust the cache at least once a month - output format: YYYY-MM.
67+
custom-cache-suffix: $(date -u "+%Y-%m")
6568

6669
# For the PHP "nightly", we need to install with ignore platform reqs as not all dependencies allow it.
6770
- name: Install Composer dependencies - with ignore platform
6871
if: ${{ matrix.experimental == true }}
6972
uses: "ramsey/composer-install@v2"
7073
with:
7174
composer-options: --ignore-platform-reqs
75+
custom-cache-suffix: $(date -u "+%Y-%m")
7276

7377
- name: Lint
7478
run: composer phplint -- --checkstyle | cs2pr
@@ -93,6 +97,9 @@ jobs:
9397

9498
- name: Install Composer dependencies - normal
9599
uses: "ramsey/composer-install@v2"
100+
with:
101+
# Bust the cache at least once a month - output format: YYYY-MM.
102+
custom-cache-suffix: $(date -u "+%Y-%m")
96103

97104
- name: Run the unit tests with code coverage
98105
run: composer coverage

0 commit comments

Comments
 (0)