-
Notifications
You must be signed in to change notification settings - Fork 528
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.
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
Improve documentation regarding dependencies caching #417
Conversation
Improve documentation regarding dependencies caching
README.md
Outdated
@@ -159,7 +159,7 @@ The `cache` input is optional, and caching is turned on by default. | |||
|
|||
The action defaults to search for the dependency file - go.sum in the repository root, and uses its hash as a part of | |||
the cache key. Use `cache-dependency-path` input for cases when multiple dependency files are used, or they are located | |||
in different subdirectories. | |||
in different subdirectories. Wildcards also supported. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To precise this syntax is not "wildcards" but rather "glob pattern" (https://en.wikipedia.org/wiki/Glob_(programming)). The difference is significant because the latter much more powerful and calling it "wildcards" could be misleading.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM - as long as the review point from @dsame is addressed
Co-authored-by: Ivan <98037481+IvanZosimov@users.noreply.github.com>
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [actions/setup-go](https://togithub.com/actions/setup-go) | action | major | `v4.1.0` -> `v5.0.0` | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>actions/setup-go (actions/setup-go)</summary> ### [`v5.0.0`](https://togithub.com/actions/setup-go/releases/tag/v5.0.0) [Compare Source](https://togithub.com/actions/setup-go/compare/v4.1.0...v5.0.0) #### What's Changed In scope of this release, we change Nodejs runtime from node16 to node20 ([https://github.com/actions/setup-go/pull/421](https://togithub.com/actions/setup-go/pull/421)). Moreover, we update some dependencies to the latest versions ([https://github.com/actions/setup-go/pull/445](https://togithub.com/actions/setup-go/pull/445)). Besides, this release contains such changes as: - Fix hosted tool cache usage on windows by [@​galargh](https://togithub.com/galargh) in [https://github.com/actions/setup-go/pull/411](https://togithub.com/actions/setup-go/pull/411) - Improve documentation regarding dependencies caching by [@​artemgavrilov](https://togithub.com/artemgavrilov) in [https://github.com/actions/setup-go/pull/417](https://togithub.com/actions/setup-go/pull/417) #### New Contributors - [@​galargh](https://togithub.com/galargh) made their first contribution in [https://github.com/actions/setup-go/pull/411](https://togithub.com/actions/setup-go/pull/411) - [@​artemgavrilov](https://togithub.com/artemgavrilov) made their first contribution in [https://github.com/actions/setup-go/pull/417](https://togithub.com/actions/setup-go/pull/417) - [@​chenrui333](https://togithub.com/chenrui333) made their first contribution in [https://github.com/actions/setup-go/pull/421](https://togithub.com/actions/setup-go/pull/421) **Full Changelog**: actions/setup-go@v4...v5.0.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/defenseunicorns/zarf). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy44Ny4yIiwidXBkYXRlZEluVmVyIjoiMzcuODcuMiIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Bumps actions/setup-go from 4 to 5. Release notes Sourced from actions/setup-go's releases. v5.0.0 What's Changed In scope of this release, we change Nodejs runtime from node16 to node20 (actions/setup-go#421). Moreover, we update some dependencies to the latest versions (actions/setup-go#445). Besides, this release contains such changes as: Fix hosted tool cache usage on windows by @galargh in actions/setup-go#411 Improve documentation regarding dependencies caching by @artemgavrilov in actions/setup-go#417 New Contributors @galargh made their first contribution in actions/setup-go#411 @artemgavrilov made their first contribution in actions/setup-go#417 @chenrui333 made their first contribution in actions/setup-go#421 Full Changelog: actions/setup-go@v4...v5.0.0 v4.1.0 What's Changed In scope of this release, slow installation on Windows was fixed by @dsame in actions/setup-go#393 and OS version was added to primaryKey for Ubuntu runners to avoid conflicts (actions/setup-go#383) This release also includes the following changes: Remove implicit dependencies by @nikolai-laevskii in actions/setup-go#378 Update action.yml by @mkelly in actions/setup-go#379 Added a description that go-version should be specified as a string type by @n3xem in actions/setup-go#367 Add note about YAML parsing versions by @dmitry-shibanov in actions/setup-go#382 Automatic update of configuration files from 05/23/2023 by @github-actions in actions/setup-go#377 Bump tough-cookie and @azure/ms-rest-js by @dependabot in actions/setup-go#392 Bump word-wrap from 1.2.3 to 1.2.4 by @dependabot in actions/setup-go#397 Bump semver from 6.3.0 to 6.3.1 by @dependabot in actions/setup-go#396 New Contributors @mkelly made their first contribution in actions/setup-go#379 @n3xem made their first contribution in actions/setup-go#367 Full Changelog: actions/setup-go@v4...v4.1.0 v4.0.1 What's Changed Update documentation for v4 by @dsame in actions/setup-go#354 Fix glob bug in the package.json scripts section by @IvanZosimov in actions/setup-go#359 Bump xml2js dependency by @dmitry-shibanov in actions/setup-go#370 Bump @actions/cache dependency to v3.2.1 by @nikolai-laevskii in actions/setup-go#374 New Contributors @nikolai-laevskii made their first contribution in actions/setup-go#374 Full Changelog: actions/setup-go@v4...v4.0.1
Bumps actions/setup-go from 4 to 5. Release notes Sourced from actions/setup-go's releases. v5.0.0 What's Changed In scope of this release, we change Nodejs runtime from node16 to node20 (actions/setup-go#421). Moreover, we update some dependencies to the latest versions (actions/setup-go#445). Besides, this release contains such changes as: Fix hosted tool cache usage on windows by @galargh in actions/setup-go#411 Improve documentation regarding dependencies caching by @artemgavrilov in actions/setup-go#417 New Contributors @galargh made their first contribution in actions/setup-go#411 @artemgavrilov made their first contribution in actions/setup-go#417 @chenrui333 made their first contribution in actions/setup-go#421 Full Changelog: actions/setup-go@v4...v5.0.0 v4.1.0 What's Changed In scope of this release, slow installation on Windows was fixed by @dsame in actions/setup-go#393 and OS version was added to primaryKey for Ubuntu runners to avoid conflicts (actions/setup-go#383) This release also includes the following changes: Remove implicit dependencies by @nikolai-laevskii in actions/setup-go#378 Update action.yml by @mkelly in actions/setup-go#379 Added a description that go-version should be specified as a string type by @n3xem in actions/setup-go#367 Add note about YAML parsing versions by @dmitry-shibanov in actions/setup-go#382 Automatic update of configuration files from 05/23/2023 by @github-actions in actions/setup-go#377 Bump tough-cookie and @azure/ms-rest-js by @dependabot in actions/setup-go#392 Bump word-wrap from 1.2.3 to 1.2.4 by @dependabot in actions/setup-go#397 Bump semver from 6.3.0 to 6.3.1 by @dependabot in actions/setup-go#396 New Contributors @mkelly made their first contribution in actions/setup-go#379 @n3xem made their first contribution in actions/setup-go#367 Full Changelog: actions/setup-go@v4...v4.1.0 v4.0.1 What's Changed Update documentation for v4 by @dsame in actions/setup-go#354 Fix glob bug in the package.json scripts section by @IvanZosimov in actions/setup-go#359 Bump xml2js dependency by @dmitry-shibanov in actions/setup-go#370 Bump @actions/cache dependency to v3.2.1 by @nikolai-laevskii in actions/setup-go#374 New Contributors @nikolai-laevskii made their first contribution in actions/setup-go#374 Full Changelog: actions/setup-go@v4...v4.0.1
Bumps actions/setup-go from 4 to 5. Release notes Sourced from actions/setup-go's releases. v5.0.0 What's Changed In scope of this release, we change Nodejs runtime from node16 to node20 (actions/setup-go#421). Moreover, we update some dependencies to the latest versions (actions/setup-go#445). Besides, this release contains such changes as: Fix hosted tool cache usage on windows by @galargh in actions/setup-go#411 Improve documentation regarding dependencies caching by @artemgavrilov in actions/setup-go#417 New Contributors @galargh made their first contribution in actions/setup-go#411 @artemgavrilov made their first contribution in actions/setup-go#417 @chenrui333 made their first contribution in actions/setup-go#421 Full Changelog: actions/setup-go@v4...v5.0.0 v4.1.0 What's Changed In scope of this release, slow installation on Windows was fixed by @dsame in actions/setup-go#393 and OS version was added to primaryKey for Ubuntu runners to avoid conflicts (actions/setup-go#383) This release also includes the following changes: Remove implicit dependencies by @nikolai-laevskii in actions/setup-go#378 Update action.yml by @mkelly in actions/setup-go#379 Added a description that go-version should be specified as a string type by @n3xem in actions/setup-go#367 Add note about YAML parsing versions by @dmitry-shibanov in actions/setup-go#382 Automatic update of configuration files from 05/23/2023 by @github-actions in actions/setup-go#377 Bump tough-cookie and @azure/ms-rest-js by @dependabot in actions/setup-go#392 Bump word-wrap from 1.2.3 to 1.2.4 by @dependabot in actions/setup-go#397 Bump semver from 6.3.0 to 6.3.1 by @dependabot in actions/setup-go#396 New Contributors @mkelly made their first contribution in actions/setup-go#379 @n3xem made their first contribution in actions/setup-go#367 Full Changelog: actions/setup-go@v4...v4.1.0 v4.0.1 What's Changed Update documentation for v4 by @dsame in actions/setup-go#354 Fix glob bug in the package.json scripts section by @IvanZosimov in actions/setup-go#359 Bump xml2js dependency by @dmitry-shibanov in actions/setup-go#370 Bump @actions/cache dependency to v3.2.1 by @nikolai-laevskii in actions/setup-go#374 New Contributors @nikolai-laevskii made their first contribution in actions/setup-go#374 Full Changelog: actions/setup-go@v4...v4.0.1
cache-dependency-path: subdir/go.sum | ||
cache-dependency-path: | | ||
subdir/go.sum | ||
tools/go.sum |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this syntax is pretty unclear. Is this parameter accepting space-separated strings? Or an array? Something like this would be more idiomatic yaml:
cache-dependency-path:
- subdir/go.sum
- tools/go.sum
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@yurishkuro This format inherited from cache action as I understood: https://github.com/actions/cache#using-a-combination-of-restore-and-save-actions
So I think it make sense to open an issue there.
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [actions/setup-go](https://togithub.com/actions/setup-go) | action | major | `v4.1.0` -> `v5.0.0` | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>actions/setup-go (actions/setup-go)</summary> ### [`v5.0.0`](https://togithub.com/actions/setup-go/releases/tag/v5.0.0) [Compare Source](https://togithub.com/actions/setup-go/compare/v4.1.0...v5.0.0) ##### What's Changed In scope of this release, we change Nodejs runtime from node16 to node20 ([https://github.com/actions/setup-go/pull/421](https://togithub.com/actions/setup-go/pull/421)). Moreover, we update some dependencies to the latest versions ([https://github.com/actions/setup-go/pull/445](https://togithub.com/actions/setup-go/pull/445)). Besides, this release contains such changes as: - Fix hosted tool cache usage on windows by [@​galargh](https://togithub.com/galargh) in [https://github.com/actions/setup-go/pull/411](https://togithub.com/actions/setup-go/pull/411) - Improve documentation regarding dependencies caching by [@​artemgavrilov](https://togithub.com/artemgavrilov) in [https://github.com/actions/setup-go/pull/417](https://togithub.com/actions/setup-go/pull/417) ##### New Contributors - [@​galargh](https://togithub.com/galargh) made their first contribution in [https://github.com/actions/setup-go/pull/411](https://togithub.com/actions/setup-go/pull/411) - [@​artemgavrilov](https://togithub.com/artemgavrilov) made their first contribution in [https://github.com/actions/setup-go/pull/417](https://togithub.com/actions/setup-go/pull/417) - [@​chenrui333](https://togithub.com/chenrui333) made their first contribution in [https://github.com/actions/setup-go/pull/421](https://togithub.com/actions/setup-go/pull/421) **Full Changelog**: actions/setup-go@v4...v5.0.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/parca-dev/parca-agent). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy44Ny4yIiwidXBkYXRlZEluVmVyIjoiMzcuODcuMiIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->
Bumps actions/setup-go from 4 to 5. Release notes Sourced from actions/setup-go's releases. v5.0.0 What's Changed In scope of this release, we change Nodejs runtime from node16 to node20 (actions/setup-go#421). Moreover, we update some dependencies to the latest versions (actions/setup-go#445). Besides, this release contains such changes as: Fix hosted tool cache usage on windows by @galargh in actions/setup-go#411 Improve documentation regarding dependencies caching by @artemgavrilov in actions/setup-go#417 New Contributors @galargh made their first contribution in actions/setup-go#411 @artemgavrilov made their first contribution in actions/setup-go#417 @chenrui333 made their first contribution in actions/setup-go#421 Full Changelog: actions/setup-go@v4...v5.0.0 v4.1.0 What's Changed In scope of this release, slow installation on Windows was fixed by @dsame in actions/setup-go#393 and OS version was added to primaryKey for Ubuntu runners to avoid conflicts (actions/setup-go#383) This release also includes the following changes: Remove implicit dependencies by @nikolai-laevskii in actions/setup-go#378 Update action.yml by @mkelly in actions/setup-go#379 Added a description that go-version should be specified as a string type by @n3xem in actions/setup-go#367 Add note about YAML parsing versions by @dmitry-shibanov in actions/setup-go#382 Automatic update of configuration files from 05/23/2023 by @github-actions in actions/setup-go#377 Bump tough-cookie and @azure/ms-rest-js by @dependabot in actions/setup-go#392 Bump word-wrap from 1.2.3 to 1.2.4 by @dependabot in actions/setup-go#397 Bump semver from 6.3.0 to 6.3.1 by @dependabot in actions/setup-go#396 New Contributors @mkelly made their first contribution in actions/setup-go#379 @n3xem made their first contribution in actions/setup-go#367 Full Changelog: actions/setup-go@v4...v4.1.0 v4.0.1 What's Changed Update documentation for v4 by @dsame in actions/setup-go#354 Fix glob bug in the package.json scripts section by @IvanZosimov in actions/setup-go#359 Bump xml2js dependency by @dmitry-shibanov in actions/setup-go#370 Bump @actions/cache dependency to v3.2.1 by @nikolai-laevskii in actions/setup-go#374 New Contributors @nikolai-laevskii made their first contribution in actions/setup-go#374 Full Changelog: actions/setup-go@v4...v4.0.1
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [actions/download-artifact](https://togithub.com/actions/download-artifact) | action | major | `v3` -> `v4` | | [actions/setup-go](https://togithub.com/actions/setup-go) | action | major | `v4.1.0` -> `v5.0.0` | | [actions/setup-go](https://togithub.com/actions/setup-go) | action | major | `v4` -> `v5` | | [actions/upload-artifact](https://togithub.com/actions/upload-artifact) | action | major | `v3.1.3` -> `v4.0.0` | | [github/codeql-action](https://togithub.com/github/codeql-action) | action | major | `v2.23.0` -> `v3.23.0` | --- ### Release Notes <details> <summary>actions/download-artifact (actions/download-artifact)</summary> ### [`v4`](https://togithub.com/actions/download-artifact/compare/v3...v4) [Compare Source](https://togithub.com/actions/download-artifact/compare/v3...v4) </details> <details> <summary>actions/setup-go (actions/setup-go)</summary> ### [`v5.0.0`](https://togithub.com/actions/setup-go/releases/tag/v5.0.0) [Compare Source](https://togithub.com/actions/setup-go/compare/v4.1.0...v5.0.0) ##### What's Changed In scope of this release, we change Nodejs runtime from node16 to node20 ([https://github.com/actions/setup-go/pull/421](https://togithub.com/actions/setup-go/pull/421)). Moreover, we update some dependencies to the latest versions ([https://github.com/actions/setup-go/pull/445](https://togithub.com/actions/setup-go/pull/445)). Besides, this release contains such changes as: - Fix hosted tool cache usage on windows by [@​galargh](https://togithub.com/galargh) in [https://github.com/actions/setup-go/pull/411](https://togithub.com/actions/setup-go/pull/411) - Improve documentation regarding dependencies caching by [@​artemgavrilov](https://togithub.com/artemgavrilov) in [https://github.com/actions/setup-go/pull/417](https://togithub.com/actions/setup-go/pull/417) ##### New Contributors - [@​galargh](https://togithub.com/galargh) made their first contribution in [https://github.com/actions/setup-go/pull/411](https://togithub.com/actions/setup-go/pull/411) - [@​artemgavrilov](https://togithub.com/artemgavrilov) made their first contribution in [https://github.com/actions/setup-go/pull/417](https://togithub.com/actions/setup-go/pull/417) - [@​chenrui333](https://togithub.com/chenrui333) made their first contribution in [https://github.com/actions/setup-go/pull/421](https://togithub.com/actions/setup-go/pull/421) **Full Changelog**: actions/setup-go@v4...v5.0.0 </details> <details> <summary>actions/upload-artifact (actions/upload-artifact)</summary> ### [`v4.0.0`](https://togithub.com/actions/upload-artifact/releases/tag/v4.0.0) [Compare Source](https://togithub.com/actions/upload-artifact/compare/v3.1.3...v4.0.0) #### What's Changed The release of upload-artifact@v4 and download-artifact@v4 are major changes to the backend architecture of Artifacts. They have numerous performance and behavioral improvements. For more information, see the [@​actions/artifact](https://togithub.com/actions/toolkit/tree/main/packages/artifact) documentation. #### New Contributors - [@​vmjoseph](https://togithub.com/vmjoseph) made their first contribution in [https://github.com/actions/upload-artifact/pull/464](https://togithub.com/actions/upload-artifact/pull/464) **Full Changelog**: actions/upload-artifact@v3...v4.0.0 </details> <details> <summary>github/codeql-action (github/codeql-action)</summary> ### [`v3.23.0`](https://togithub.com/github/codeql-action/compare/v3.22.12...v3.23.0) [Compare Source](https://togithub.com/github/codeql-action/compare/v3.22.12...v3.23.0) ### [`v3.22.12`](https://togithub.com/github/codeql-action/compare/v3.22.11...v3.22.12) [Compare Source](https://togithub.com/github/codeql-action/compare/v3.22.11...v3.22.12) ### [`v3.22.11`](https://togithub.com/github/codeql-action/compare/v2.22.11...v3.22.11) [Compare Source](https://togithub.com/github/codeql-action/compare/v2.23.0...v3.22.11) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 6am on monday" in timezone Australia/Sydney, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://togithub.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/google/osv-scanner). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy45My4xIiwidXBkYXRlZEluVmVyIjoiMzcuMTI3LjAiLCJ0YXJnZXRCcmFuY2giOiJtYWluIn0=-->
Description:
Just a highlighting that
cache-dependency-path
parameter can accept multiple files and can handle wildcards + example.Related issue:
#371
Check list: