Commit Graph

136 Commits (8585f2ac5c35871385bd153f184fa6d6b3a6e5c3)

Author SHA1 Message Date
Jan T. Sott 8469c94c6a
Add Bun example (#1456)
* Add Bun example

* Fix Bun Windows example
2024-10-08 19:53:09 +00:00
Josh Gross 3624ceb22c
Restore original behavior of `cache-hit` output (#1467)
* Restore original behavior of `cache-hit` output

* Bump version to 4.1.1
2024-10-08 13:08:22 -04:00
Josh Gross c74ca4022c
Deprecate `save-always` input (#1452)
The `save-always` input added in v4 is not
working as intended due to
`post-if` expressions not supporting the input
context.
To avoid breaking users who have already added
this input to their workflows, it is being
deprecated now and will be removed
in the next major version (v5).
See https://github.com/actions/cache/issues/1315 for more details.
2024-10-03 18:37:55 +00:00
Soubhik Kumar Mitra 57b8e405f0
Clarify that the `restore-keys` input is a string in the docs (#1434)
* Fix Description for restore-keys at Readme

As previously the restore-keys were defined as an ordered lists which is
wrong as per the issue description where the actual format is a
multi-line string with one key per line.

* Added a space between the sentence of restore-keys description

While at the PR review it's been identified there's a need for a space
between the sentence

	```
	An ordered multiline string listing the prefix-matched keys,that are
	used for restoring stale cache if no cache hit occurred for key.
	```

where it's written as "prefix-matched keys,that are" this commit will
address the review comment and introduce a space between
"prefix-matched keys, that are" and change the sentence to

	```
	An ordered multiline string listing the prefix-matched keys, that are
        used for restoring stale cache if no cache hit occurred for key.
	```

* Change restore-keys description at cache/restore/action.yml and cache/action.yml
2024-08-06 14:26:54 +00:00
P. Ottlinger 4a28cbc054
Update README.md and use v4 of checkout action (#1437)
Update examples to use latest available checkout action v4.
2024-07-29 16:07:30 -04:00
Yang Cao dc88ab52d7 Update examples 2024-01-17 11:42:01 -05:00
Yang Cao c36458f13b
Update README.md 2024-01-17 11:31:56 -05:00
Bishal Prasad 5cb4bb86c0
Merge branch 'main' into bishal-pdMSFT-patch-4 2023-03-13 18:54:39 +05:30
Sankalp Kotewar 84995e0d91
Updated description of the lookup-only input for main action (#1130)
* Updated description of the lookup-only input for main action

* Update README.md

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Update README.md

---------

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>
2023-03-13 16:43:13 +05:30
Bishal Prasad bf96a3f9d8
Merge branch 'main' into bishal-pdMSFT-patch-4 2023-03-13 15:41:54 +05:30
Sankalp Kotewar 57014a2baa
Readme fixes (#1134)
* Update README.md

* Update README.md
2023-03-13 12:02:23 +05:30
Sankalp Kotewar cb865c1889
Fixed readme with new segment timeout values (#1133) 2023-03-13 11:02:55 +05:30
Bishal Prasad 4e7c82221f
Merge branch 'main' into bishal-pdMSFT-patch-4 2023-03-13 11:01:00 +05:30
Sankalp Kotewar 88522ab9f3
Reduced download segment size to 128 MB and timeout to 10 minutes (#1129)
* Changed segment size to 128mb & timeout to 10 min

* Updated license

* Updated licenses
2023-03-13 10:32:46 +05:30
Bishal Prasad 7893481812
Change two new actions mention as quoted text 2023-03-11 21:32:05 +05:30
Marc Mueller 940f3d7cf1
Add `lookup-only` option (#1041)
* Add new actions/cache version (with dryRun support)

* Add dry-run option

* Changes after rebase

* Update readme

* Rename option to lookup-only

* Update test name

* Update package.json + changelog

* Update README

* Update custom package version

* Update custom package version

* Update @actions/cache to 3.2.0

* Code review

* Update log statement

* Move test case

---------

Co-authored-by: Sankalp Kotewar <98868223+kotewar@users.noreply.github.com>
2023-03-09 18:00:28 +05:30
Lovepreet Singh b1db4b4897 Fix zstd breaking after new version release 2023-02-20 19:51:54 +00:00
Josh Soref 22d3da765b
Rewrite readmes (#1085)
* Improve readmes

* Add markdown for default value

Co-authored-by: Sankalp Kotewar <98868223+kotewar@users.noreply.github.com>

---------

Co-authored-by: Sankalp Kotewar <98868223+kotewar@users.noreply.github.com>
2023-01-31 16:01:15 +05:30
Marc Mueller 627f0f41f6
Add `fail-on-cache-miss` option (#1036)
* Add fail-on-cache-miss option

* Small improvements

* Changes after rebase

* Update description

* Only fail if no cache entry is found

* Code review

* Update readme

* Add additional test case

* Bump version + changelog

* Update package-lock.json

* Update Readme
2023-01-30 16:40:58 +05:30
Philip b63536828e
there as well ;) 2023-01-19 21:08:05 +01:00
Philip cd2aaa9df8
chore: Fix syntax error typo 2023-01-19 21:04:46 +01:00
Tanuj Kumar Mishra 003f5452bf
Merge branch 'main' into update-docs 2023-01-12 16:48:49 +05:30
Lovepreet Singh 76ee6bdfdc
Merge branch 'main' into pdotl-patch-1 2023-01-12 16:07:16 +05:30
Sankalp Kotewar 9183691e97
Cache recipes for cache, restore and save actions (#1055)
* Added outline and cache basics

* Update CACHING.md

* Added info about key and restore keys

* Update CACHING.md

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Review comments and some snippets

* Updated doc with comments

* Formatted sub headings

* Markdown linting

* Added paths

* Fixed heading

* Update CACHING.md

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Update CACHING.md

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Update CACHING.md

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Update CACHING.md

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Update CACHING.md

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Update CACHING.md

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Update CACHING.md

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Update CACHING.md

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Update CACHING.md

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Update CACHING.md

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Update CACHING.md

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Update CACHING.md

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Update CACHING.md

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Update CACHING.md

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Updated paths

* Renamed file and added readme reference

* Fixed heading of a section

* Update README.md

* Moved back section to strategies

* Reverted to older version

* Fixed broken link

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>
2023-01-12 12:00:47 +05:30
Lovepreet Singh 094a24099d
Add gnu tar and zstd as pre-requisites for windows self-hosted runners
## Context

There have been customer requests to document installation of gnu tar and zstd for self-hosted runners. We had them documented in workarounds before. Adding them to pre-requisites for better visibility for folks using self-hosted windows runners.
2023-01-10 22:52:32 +05:30
Sampark Sharma 58c146cc91
Release support for cross-os caching as opt-in feature (#1060)
* Release support for cross-os caching as opt-in feature
Add documentation for cross-os caching

* Apply suggestions from code review

Co-authored-by: Lovepreet Singh <pdotl@github.com>

* Address review comments

Co-authored-by: Lovepreet Singh <pdotl@github.com>
2023-01-09 11:01:52 +05:30
Sankalp Kotewar 1f414295fe
Fixed broken link (#1057) 2023-01-05 12:14:32 +05:30
uhooi 84e54000da Merge remote-tracking branch 'origin/main' into feature/add_mint_example 2022-12-29 22:27:37 +09:00
Lovepreet Singh d0e7eb01c9
Merge branch 'main' into update-docs 2022-12-29 13:29:36 +05:30
Sampark Sharma 4723a57e26
Revert compression changes related to windows but keep version logging (#1049)
* Revert compression changes related to windows
 due to symlink issues

* Added tips and workarounds for cross os
2022-12-27 16:38:40 +05:30
SIGUI Kessé Emmanuel d70353d8a4 📝 #1045 update using the `set-output` command is deprecated 2022-12-26 07:12:46 +01:00
Adam Dinwoodie 501277cfd7 README.md: remove outdated Windows cache tip link
As of 9b0be58 (Release compression related changes for windows (#1039),
2022-12-23), the section of tips-and-workarounds.md referring to
improving cache restore performance on Windows no longer exists, so
don't link to it from README.md.
2022-12-24 13:15:08 +00:00
Sampark Sharma 9b0be58822
Release compression related changes for windows (#1039)
* Release compression related changes for windows

* Update license
2022-12-23 11:49:17 +05:30
Sankalp Kotewar c17f4bf466
GA for granular cache (#1035)
* Add example for Haskell Stack

* Revert "Add example for Haskell Stack"

* Basic implementation

* Updated variable name

* Adding wrapper class

* Changed logs to warnings

* added debug logs

* experimenting

* Test

* test

* new try

* test

* Impl separated

* Reverted wrapper changes

* Added test cases

* Some cleanup

* Formatted document

* Fixed test cases issues

* Slight modification for test cases check

* Updated new actions' input descriptions

* Reverted custom asks implemented and added wrapper

* refactor into a generic outputter

* Readme draft for new actions

* Generated dist

* Fixed breaking test case

* Removed return type in promise

* Removed commented lines

* Calling methods from same file

* dist

* update save as well

* fix merge

* Changes for beta release

* Update dist folder

* Fixed formatting

* dist

* Add support for gzip fallback for restore of old cache on windows

* Fixed test cases

* Fixed test cases

* Added restore only and save only test cases

* Updated new actions dist files

* Removed comments

* Fixed inputs

* Renamed variables and added tests

* Fixed breaking test case

* Fixed review comments and tests

* added stateprovider changes

* Deleted stateprovider tests until added

* Added stateprovider test cases

* Fixed breaking test case

* Updated outputs of restore action

* Changes for beta release

* Update dist folder

* Add support for gzip fallback for restore of old cache on windows

* update for new beta release

* Update save/action.yml

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Update restore/action.yml

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Update restore/action.yml

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Update restore/action.yml

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Update restore/action.yml

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Added more assertions as values can't be checked

* Removed unused code

* Merged beta branch and resolved conflicts

* Added save readme

* Updates to save readme

* Renamed output

* Added cache hit info in readme

* Update restore/README.md

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Update restore/README.md

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Update restore/README.md

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Update save/README.md

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Update save/README.md

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Removed verbose statements

* Repositioned new actions introduction

* Added test case for restore state

* Addressed review comments

* nit

* nit: added language to code blocks

* Updated beta version to 3.2.0-beta.1

* Added stateprovider mock implementations

* Linting errors fixed

* Save-only warning added

* Updated return ID to -2

* Removed -2 error code

* Removed comment

* Updated cache npm lib version

* Updated license version

* Updated releases.md

* Updated readme with the new actions in what's new

Co-authored-by: Malo Bourgon <mbourgon@gmail.com>
Co-authored-by: Vipul <vsvipul@github.com>
Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>
Co-authored-by: Tanuj Kumar Mishra <tanuj077@users.noreply.github.com>
Co-authored-by: Sampark Sharma <phantsure@github.com>
2022-12-21 19:38:44 +05:30
Deepak Dahiya 6babf202a4
Readme update for deleting caches (#981)
* Readmee update for deleting caches

* minor

* minor

* PR comments

* PR comments

* PR comments

* moved to tips-and-workarounds

* minor
2022-11-21 14:43:40 +05:30
Sankalp Kotewar 3ff04605d3
Updated link for cache segment download info 2022-11-16 14:44:08 +05:30
Asaf Levy 0e93819da5
Update hashFiles documentation reference
Update hashFiles documentation reference Link to the valid doc
https://docs.github.com/en/actions/learn-github-actions/expressions#hashfiles
2022-11-09 21:38:02 +02:00
Bishal Prasad 9a6a4f6079
Add more details to version section in readme (#971)
* Add more details to version section in readme

* Update README.md

Co-authored-by: Sankalp Kotewar <98868223+kotewar@users.noreply.github.com>

* Use ubuntu/squid instead of datadog/squid

Co-authored-by: Sankalp Kotewar <98868223+kotewar@users.noreply.github.com>
2022-11-07 15:42:42 +05:30
Sankalp Kotewar 14f2d18ea2
Moved recommendation to skipping steps section 2022-10-26 11:15:05 +00:00
Sankalp Kotewar 5294b3f306
Update README.md 2022-10-19 00:41:06 +05:30
Rong Rong 2b04a41915
timeout env var key is not correct in README.md (#959) 2022-10-18 10:56:49 +05:30
Sampark Sharma 862fc14188
Update README.md 2022-10-04 15:10:37 +05:30
ELHoussineT f85d12c3b2
Merge branch 'main' into patch-1 2022-10-03 10:16:35 +02:00
ELHoussineT 98044e486f
Update README.md 2022-10-03 10:15:54 +02:00
Aparna Ravindra 12681847c6
Update README.md (#936) 2022-09-23 17:15:41 +05:30
ELHoussineT 3238536a48
Update README.md 2022-09-22 10:50:41 +02:00
Lovepreet Singh 9f98a2f01c
Merge branch 'main' into pdotl/readme-update-1 2022-08-30 14:02:27 +05:30
Lovepreet Singh 471fb0c87e Move workarounds to a different file 2022-08-30 08:24:10 +00:00
Vipul 0c180092a2
Add a note about path expansion on Windows. 2022-08-29 17:16:27 +05:30
Lovepreet Singh a057257949 Add cross-os caching to the zstd workaround section. 2022-08-26 09:00:35 +00:00