Add inputs.cache-save-always
#34
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
Adds an input that borrows the `save-always` input from [v4 of `actions/cache`][0], which will run the post step to save the cache even if a failure occurs. Using the added `cache-save-always` input saves the cache when a build fails, which will speed up subsequent runs which restore the partial build. This comes at the cost of requiring a build when there is an exact `key` match, since the cache from a failed build will have the same `key` as a completed build. [0]: https://github.com/actions/cache/tree/main#v4
|
This will require a major version since this changes the noop-behavior on a full cache hit. If the trade-offs seem worthwhile (and I'm not missing anything about how Stack might treat these artifacts) then I'll bump the version and update the docs. |
pbrisbin
reviewed
Jan 18, 2024
Sounds good; I wasn't sure how to characterize the risk of removing the noop. The behavior is certainly the same and what is changed in the default scenario, not making use of the input, is an implementation detail. |
pbrisbin
requested changes
Jan 19, 2024
Saves the set of build artifacts after a build failure with a `-partial` suffix on the cache key. A full cache-hit will therefore only occur when restoring the cache saved after a successful build, allowing for the subsequent `stack build` and cache-save steps to be skipped.
stackptr
force-pushed
the
corey/save-always
branch
from
b171ee0 to
629a6a9
Compare
Status check functions can only be used in `if` conditionals, so the use of a cache key suffix needs to be determined in a conditionally-run step.
This reverts commit dd40c85.
This reverts commit 629a6a9.
Checks that the workflow has not been cancelled (i.e., is succeeding or failed) and that `cache-save-always: true` when building and saving the cache. This extends the existing conditional on the `cache-hit` outputs, making the previously-implied `success()` check explicit. When `cache-save-always: false`, the default behavior is unchanged for the action: steps either no-op if a cache-hit occurred, or build and save otherwise. When `cache-save-always: true`, a building and saving the cache occurs on success or failure.
pbrisbin
approved these changes
Jan 22, 2024
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.
Adds an input that borrows the
save-alwaysinput from v4 ofactions/cache, which will run the post step to save the cache even if a failure occurs. Using the addedcache-save-alwaysinput saves the cache when a build fails, which will speed up subsequent runs which restore the partial build. This comes at the cost of requiring a build when there is an exactkeymatch, since the cache from a failed build will have the samekeyas a completed build.