Skip to content

Build/Test Tools: Cache and retry WP-CLI downloads #14789

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

Draft
lucatume wants to merge 1 commit into
base: trunk
Choose a base branch
from
+114 −3
Draft

Build/Test Tools: Cache and retry WP-CLI downloads #14789

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
38 changes: 37 additions & 1 deletion .github/workflows/install-testing.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,43 @@ jobs:
with:
php-version: '${{ matrix.php }}'
coverage: none
tools: ${{ contains( fromJSON('["5.4", "5.5"]'), matrix.php ) && 'wp-cli:2.4.0' || 'wp-cli' }}

# Not installed with the setup-php `tools` input: that downloads WP-CLI in a single attempt
# and only logs an error on failure, so the job breaks later with `wp: command not found`.
# The phar is cached in 6 hour windows, so jobs keep getting new WP-CLI releases without each
# downloading it. When a new window's download fails, the previous window's phar is used instead.
- name: Get the WP-CLI cache window
id: get-wp-cli-window
run: echo "window=$(( $(/bin/date -u '+%s') / WP_CLI_CACHE_SECONDS ))" >> "$GITHUB_OUTPUT"
env:
WP_CLI_CACHE_SECONDS: 21600 # 6 hours.

- name: Cache WP-CLI
id: cache-wp-cli
uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
with:
path: ${{ runner.temp }}/wp-cli.phar
key: ${{ runner.os }}-wp-cli-${{ contains( fromJSON('["5.4", "5.5"]'), matrix.php ) && '2.4.0' || 'latest' }}-${{ steps.get-wp-cli-window.outputs.window }}
restore-keys: ${{ runner.os }}-wp-cli-${{ contains( fromJSON('["5.4", "5.5"]'), matrix.php ) && '2.4.0' || 'latest' }}-

- name: Install WP-CLI
run: |
if [ "$CACHE_HIT" != 'true' ]; then
if curl --fail --silent --show-error --location --retry 5 --retry-all-errors \
--output "${RUNNER_TEMP}/wp-cli.phar.download" "$WP_CLI_URL"; then
mv "${RUNNER_TEMP}/wp-cli.phar.download" "${RUNNER_TEMP}/wp-cli.phar"
elif [ -f "${RUNNER_TEMP}/wp-cli.phar" ]; then
echo "::warning::Could not download WP-CLI, using the previously cached version."
else
echo "::error::Could not download WP-CLI."
exit 1
fi
fi
sudo install -m 0755 "${RUNNER_TEMP}/wp-cli.phar" /usr/local/bin/wp
wp --version
env:
CACHE_HIT: ${{ steps.cache-wp-cli.outputs.cache-hit }}
WP_CLI_URL: ${{ contains( fromJSON('["5.4", "5.5"]'), matrix.php ) && 'https://github.com/wp-cli/wp-cli/releases/download/v2.4.0/wp-cli-2.4.0.phar' || 'https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar' }}

- name: Download WordPress
run: wp core download --version="${WP_VERSION}"
Expand Down
41 changes: 40 additions & 1 deletion .github/workflows/reusable-performance-test-v2.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,9 +140,48 @@ jobs:
uses: shivammathur/setup-php@f3e473d116dcccaddc5834248c87452386958240 # 2.37.2
with:
php-version: ${{ inputs.php-version }}
tools: wp-cli
coverage: none

# Not installed with the setup-php `tools` input: that downloads WP-CLI in a single attempt
# and only logs an error on failure, so the job breaks later with `wp: command not found`.
# The phar is cached in 6 hour windows, so jobs keep getting new WP-CLI releases without each
# downloading it. When a new window's download fails, the previous window's phar is used instead.
- name: Get the WP-CLI cache window
id: get-wp-cli-window
if: ${{ inputs.subject == 'base' }}
run: echo "window=$(( $(/bin/date -u '+%s') / WP_CLI_CACHE_SECONDS ))" >> "$GITHUB_OUTPUT"
env:
WP_CLI_CACHE_SECONDS: 21600 # 6 hours.

- name: Cache WP-CLI
id: cache-wp-cli
if: ${{ inputs.subject == 'base' }}
uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
with:
path: ${{ runner.temp }}/wp-cli.phar
key: ${{ runner.os }}-wp-cli-latest-${{ steps.get-wp-cli-window.outputs.window }}
restore-keys: ${{ runner.os }}-wp-cli-latest-

- name: Install WP-CLI
if: ${{ inputs.subject == 'base' }}
run: |
if [ "$CACHE_HIT" != 'true' ]; then
if curl --fail --silent --show-error --location --retry 5 --retry-all-errors \
--output "${RUNNER_TEMP}/wp-cli.phar.download" "$WP_CLI_URL"; then
mv "${RUNNER_TEMP}/wp-cli.phar.download" "${RUNNER_TEMP}/wp-cli.phar"
elif [ -f "${RUNNER_TEMP}/wp-cli.phar" ]; then
echo "::warning::Could not download WP-CLI, using the previously cached version."
else
echo "::error::Could not download WP-CLI."
exit 1
fi
fi
sudo install -m 0755 "${RUNNER_TEMP}/wp-cli.phar" /usr/local/bin/wp
wp --version
env:
CACHE_HIT: ${{ steps.cache-wp-cli.outputs.cache-hit }}
WP_CLI_URL: https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar

- name: Log debug information
run: |
npm --version
Expand Down
38 changes: 37 additions & 1 deletion .github/workflows/reusable-upgrade-testing.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,43 @@ jobs:
with:
php-version: '${{ inputs.php }}'
coverage: none
tools: wp-cli

# Not installed with the setup-php `tools` input: that downloads WP-CLI in a single attempt
# and only logs an error on failure, so the job breaks later with `wp: command not found`.
# The phar is cached in 6 hour windows, so jobs keep getting new WP-CLI releases without each
# downloading it. When a new window's download fails, the previous window's phar is used instead.
- name: Get the WP-CLI cache window
id: get-wp-cli-window
run: echo "window=$(( $(/bin/date -u '+%s') / WP_CLI_CACHE_SECONDS ))" >> "$GITHUB_OUTPUT"
env:
WP_CLI_CACHE_SECONDS: 21600 # 6 hours.

- name: Cache WP-CLI
id: cache-wp-cli
uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
with:
path: ${{ runner.temp }}/wp-cli.phar
key: ${{ runner.os }}-wp-cli-latest-${{ steps.get-wp-cli-window.outputs.window }}
restore-keys: ${{ runner.os }}-wp-cli-latest-

- name: Install WP-CLI
run: |
if [ "$CACHE_HIT" != 'true' ]; then
if curl --fail --silent --show-error --location --retry 5 --retry-all-errors \
--output "${RUNNER_TEMP}/wp-cli.phar.download" "$WP_CLI_URL"; then
mv "${RUNNER_TEMP}/wp-cli.phar.download" "${RUNNER_TEMP}/wp-cli.phar"
elif [ -f "${RUNNER_TEMP}/wp-cli.phar" ]; then
echo "::warning::Could not download WP-CLI, using the previously cached version."
else
echo "::error::Could not download WP-CLI."
exit 1
fi
fi
sudo install -m 0755 "${RUNNER_TEMP}/wp-cli.phar" /usr/local/bin/wp
wp --version
env:
CACHE_HIT: ${{ steps.cache-wp-cli.outputs.cache-hit }}
WP_CLI_URL: https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar

- name: Download WordPress ${{ inputs.wp }}
run: wp core download --version="${WP_VERSION}"
Expand Down
Loading