GH Actions: various tweaks #325
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
... of the bash `date` command in the earlier pulled cache busting.
All the repos in the Yoast organisation contain a `<arg name="cache" value="./.cache/phpcs.cache"/>` directive in the PHPCS ruleset. This directive makes running PHPCS faster by caching the run results in a file and only scanning changed files when running PHPCS again. However, when there is no cache available, running with the `cache` option enabled will make PHPCS _slower_ as the cache needs to be created and the file read/write actions slow PHPCS down. In GH Actions, we are not caching the PHPCS `cache` file, which means that there is cache file available and running with `cache` will be slower. By adding the `--no-cache` option, the `cache` directive in the ruleset is ignored, which should result in a slightly faster runtime for the CS workflow. Note: the alternative would be to _cache_ the cache file in GH Actions, but aside from the two very frequently changing repos, there's not much point doing that.
jrfnl
added
yoast cs/qa
changelog: non-user-facing
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR can be summarized in the following changelog entry:
Relevant technical choices:
GH Actions: minor simplification
... of the bash
datecommand in the earlier pulled cache busting.GH Actions: improve performance of the CS step
All the repos in the Yoast organisation contain a
<arg name="cache" value="./.cache/phpcs.cache"/>directive in the PHPCS ruleset.This directive makes running PHPCS faster by caching the run results in a file and only scanning changed files when running PHPCS again.
However, when there is no cache available, running with the
cacheoption enabled will make PHPCS slower as the cache needs to be created and the file read/write actions slow PHPCS down.In GH Actions, we are not caching the PHPCS
cachefile, which means that there is cache file available and running withcachewill be slower.By adding the
--no-cacheoption, thecachedirective in the ruleset is ignored, which should result in a slightly faster runtime for the CS workflow.Note: the alternative would be to cache the cache file in GH Actions, but aside from the two very frequently changing repos, there's not much point doing that.
Test instructions
This PR can be tested by following these steps: