Add support to cache on specific json keys #51
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
72636c
approved these changes
Apr 8, 2024
| - package.json#.devDependencies | ||
| - package.json#.pnpm.overrides | ||
| - yarn.lock | ||
| - docker#v3.12.0: |
There was a problem hiding this comment.
Might be time to renovate these references 😅
There was a problem hiding this comment.
I'll tweak them in a separate PR, too many changes otherwise
README.md
Outdated
| @@ -76,6 +76,23 @@ steps: | |||
| - /workdir/node_modules | |||
| ``` | |||
|
|
|||
| It also supports caching on specific JSON keys which can be specified following a `#` character using [jq syntax](https://jqlang.github.io/jq/manual/#object-identifier-index). This requires [jq](https://jqlang.github.io/jq/) to be installed on the build agent. You cannot use this in conjunction with Bash globbing. | |||
There was a problem hiding this comment.
More for our internal understanding, is it worth clarifying
- The implementation matches on the first
.json#substring, which would be silly to have elsewhere in your file path but is nonetheless possible on Unix systems - A given entry cannot mix globbing and jq paths, but you can do
['**/LICENSE.md', 'package.json#.dependencies']
72636c
reviewed
Apr 8, 2024
README.md
Outdated
Comment on lines
83
to
90
| - command: npm test | ||
| plugins: | ||
| - seek-oss/docker-ecr-cache#v2.2.0: | ||
| cache-on: | ||
| - package.json#.dependencies | ||
| - package.json#.devDependencies | ||
| - package.json#.pnpm.overrides | ||
| - yarn.lock |
There was a problem hiding this comment.
Would it be useful to list our recommended set of cache keys for a typical pnpm project here?
Suggested change
| - command: npm test | |
| plugins: | |
| - seek-oss/docker-ecr-cache#v2.2.0: | |
| cache-on: | |
| - package.json#.dependencies | |
| - package.json#.devDependencies | |
| - package.json#.pnpm.overrides | |
| - yarn.lock | |
| - command: pnpm install --offline && pnpm test | |
| plugins: | |
| - seek-oss/docker-ecr-cache#v2.2.0: | |
| cache-on: | |
| - .npmrc | |
| - package.json#.dependencies | |
| - package.json#.devDependencies | |
| - package.json#.packageManager | |
| - package.json#.pnpm.overrides | |
| - pnpm-lock.yaml |
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.
Addressing: seek-oss/skuba#1512
Tested on one of my repos:
Cache hit in pipeline while changing package.json
https://github.com/SEEK-Jobs/hirer-budgets/compare/eb9853f8c9cc4aa4939faaf9ca764148dc351aa8...b0d8c4db2e9a6e501a51a52356c41987b1de8b53