Skip to content

Commit d8a621c

Browse files
committed
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 cc09853 commit d8a621c

File tree

3 files changed

+10
-0
lines changed

3 files changed

+10
-0
lines changed

.github/workflows/cs.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ jobs:
4949
# @link https://github.com/marketplace/actions/install-composer-dependencies
5050
- name: Install Composer dependencies
5151
uses: "ramsey/composer-install@v2"
52+
with:
53+
# Bust the cache at least once a month - output format: YYYY-MM-DD.
54+
custom-cache-suffix: $(date -u -d "-0 month -$(($(date +%d)-1)) days" "+%F")
5255

5356
# @link http://xmlsoft.org/xmllint.html
5457
- name: Install xmllint

.github/workflows/quicktest.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,9 @@ jobs:
7272
# @link https://github.com/marketplace/actions/install-composer-dependencies
7373
- name: Install Composer dependencies
7474
uses: "ramsey/composer-install@v2"
75+
with:
76+
# Bust the cache at least once a month - output format: YYYY-MM-DD.
77+
custom-cache-suffix: $(date -u -d "-0 month -$(($(date +%d)-1)) days" "+%F")
7578

7679
- name: Lint against parse errors (PHP 7.2+)
7780
if: ${{ matrix.phpcs_version == 'dev-master' && matrix.php >= '7.2' }}

.github/workflows/test.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,13 +106,17 @@ jobs:
106106
- name: Install Composer dependencies - normal
107107
if: ${{ matrix.php < 8.2 }}
108108
uses: "ramsey/composer-install@v2"
109+
with:
110+
# Bust the cache at least once a month - output format: YYYY-MM-DD.
111+
custom-cache-suffix: $(date -u -d "-0 month -$(($(date +%d)-1)) days" "+%F")
109112

110113
# For PHP "nightly", we need to install with ignore platform reqs as not all dependencies allow installation.
111114
- name: Install Composer dependencies - with ignore platform
112115
if: ${{ matrix.php >= 8.2 }}
113116
uses: "ramsey/composer-install@v2"
114117
with:
115118
composer-options: --ignore-platform-reqs
119+
custom-cache-suffix: $(date -u -d "-0 month -$(($(date +%d)-1)) days" "+%F")
116120

117121
- name: Lint against parse errors (PHP 7.2+)
118122
if: ${{ matrix.phpcs_version == 'dev-master' && matrix.php >= '7.2' }}

0 commit comments

Comments
 (0)