132 Commits

Author SHA1 Message Date
todgru
104f95683b update documentation to use <action>@v4 2024-01-26 14:08:22 -08: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
Lovepreet Singh
7b5e3aaf23 Move remaining section of Cache segment restore timeout 2022-08-25 13:18:15 +00:00
Lovepreet Singh
eb8b610ee6 Add zstd workaround to README. Add yaml formatting to code blocks. Move Cache segment restore to Known Practices section. 2022-08-25 13:14:23 +00:00
Lovepreet Singh
7e7820edca Move Cache segment restore timeout to Known practices and workarounds 2022-08-25 05:52:10 +00:00
Bishal Prasad
5f975d03e6
Merge pull request #896 from actions/bishal-pdMSFT-patch-1
Add readme section for good practices
2022-08-23 16:33:03 +05:30
Bishal Prasad
8a9a57869f
Update README.md 2022-08-23 15:20:27 +05:30
Bishal Prasad
fb1d96e3ff
Update README.md 2022-08-23 13:19:05 +05:30
Sankalp Kotewar
d49b6bb21d Updated actions/cache toolkit dep to v3.0.4 2022-08-18 14:13:31 +00:00
Bishal Prasad
23d218be27
Add section for good practices 2022-08-14 14:35:33 +05:30
Sankalp Kotewar
33a923d660 Added release information 2022-08-09 16:48:03 +00:00
Lovepreet Singh
318935ef66 Update README and RELEASES 2022-08-04 10:37:56 +00:00
Sankalp Kotewar
4387dbc81a
Merge pull request #835 from shivamarora1/clojure-lein-example
feat: 🎸 add example for clojure lein project deps
2022-08-01 13:27:13 +05:30
Vipul
baed3516c3
Merge pull request #530 from axelson/document-where-to-cache
Make it more obvious that the cache call does double duty
2022-06-27 10:56:37 +05:30
Vipul
8829e97be1
Update README.md
Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
2022-06-27 10:48:52 +05:30
Shivam Arora
a0e530f115 feat: 🎸 add example for clojure lein project deps
In Clojure, Lein tool is used to generate template for various projects.
Lein project metadata (including project dependencies) are stored in
prject.clj (in root directory) file. Lein downloads dependencies in
classpath (~/.m2/repository). So here I am caching ~/.m2/repository path
for reusing cache in subsequent builds.
2022-06-26 00:39:24 +05:30
Luis Obis
02be3a9c73
fixed bad yaml in README example 2022-06-08 21:43:57 +02:00
Sankalp Kotewar
c3f1317a9e
Merge pull request #813 from actions/users/kotewar/upgrading-cache-to-v2.0.6
Updated README file with release info
2022-06-07 13:07:13 +05:30
Sankalp Kotewar
d0a54b996c Fixed typo 2022-06-07 07:14:00 +00:00
Sankalp Kotewar
8c5bd0c82d Updated README file with release info 2022-06-07 07:11:42 +00:00
Sampark Sharma
438628ac22
Merge pull request #554 from albertstill/improve-restore-key-docs
Improve restore-key documentation
2022-06-06 17:29:02 +05:30
Sankalp Kotewar
f2ea0f25f2 Updated Readme with what's new and removed v2 info 2022-05-31 03:33:14 +00:00
Sampark Sharma
11dd8059a1
Addressing comments 2022-05-24 06:31:12 +00:00
Sampark Sharma
e19e89eb2a
Update to call out for version of cache 2022-05-20 14:38:22 +05:30
Peter Mescalchin
8f1e2e0286
Bump GitHub actions actions/checkout and actions/setup-node (#763)
* Bump GitHub actions

* Bump Node.js version used to `16.x` in workflows

* Bump `actions/upload-artifact@v3`
2022-04-12 00:06:07 +05:30
Shubham Tiwari
136d96b4ae
Enabling actions/cache for GHES based on presence of AC service (#774)
* initial changes

* Update package-lock.json

* Update package-lock.json

* review comments and updated test cases

* package.json

* changed name

* added new line

* changed tookit

* updated with 2.0

* changed with public released package

* ran code format

* linting errors

* Update actionUtils.test.ts

* Update cache.dep.yml

* Update package.json

* Update README.md

* Create RELEASES.md

* Update RELEASES.md

* Update package.json

* Update package-lock.json

* typo
2022-03-30 15:46:49 +05:30
Ashwin Sangem
7d4f40b464
Bumping up the version to fix download issue for files > 2 GB. (#775)
* Bumping up the version to fix download issue for files > 2 GB.

* Update license for cache

Co-authored-by: vsvipul <vsvipul@github.com>
2022-03-30 15:33:23 +05:30
Ashwin Sangem
2d8d0d1c9b
Updated what's new. (#771)
* Updated what's new.

* Segregated major versions and added changelog.

* Update README.md
2022-03-22 14:04:39 +05:30
Ashwin Sangem
7799d864d9
Updated the usage and docs to the major version release. (#770) 2022-03-21 14:31:26 +05:30
Vipul
deae296ab3
Merge pull request #651 from magnetikonline/fix-golang-windows-example
Fix Golang windows example - updated `README.md` test badge markdown.
2022-03-09 18:22:38 +05:30
Vipul
c7c46bcb6d
Merge pull request #707 from duxtland/main
Add Deno cache example
2022-02-24 15:51:48 +05:30
Peter Mescalchin
3fdafa472e Update GitHub Actions status badge markdown in README.md 2022-02-24 16:32:52 +11:00
Peter Mescalchin
341e6d75d9
Merge branch 'actions:main' into fix-golang-windows-example 2022-02-24 16:28:28 +11:00
Jheyson Saavedra
3fe001f5ca
chore: add Deno cache example to readme 2022-02-23 16:18:41 -05:00
Malo Bourgon
2c7b30f330 Add example for Haskell Stack 2022-02-22 10:21:09 -08:00
Juan Julián Merelo Guervós
a848fb313f
This is a good tip if you're using Alpine
(Which does not have a POSIX-compliant tar by default)
2022-01-28 07:38:27 +01:00
Vipul
e6890046a6
Update README.md
Co-authored-by: Brian Cristante <33549821+brcrista@users.noreply.github.com>
2021-12-17 15:43:24 +05:30
Tugdual Grall
a3b6799c91 update readme for issue #687 2021-11-29 14:51:07 +00:00
Aparna Ravindra
bd49291365
Update README.md - 10GB support 2021-11-23 21:35:12 +05:30
Peter Mescalchin
447f0fd1d3 Chomp some markdown whitespace 2021-09-26 22:10:48 +10:00
Peter Mescalchin
47e8bd685f Small fix to README.md examples link 2021-09-26 22:10:29 +10:00
Albert Still
3767bf0386 Improve restore-key documentation 2021-03-26 10:36:55 +11:00
Robert Stoll
4134e6de47
It is not recommended to cache node_modules (#537)
According to the docs of this repo, so the example should not show it
2021-02-17 13:18:00 -05:00
Jason Axelson
2086306d9c Make it more obvious that the cache call does double duty 2021-02-06 13:36:42 -10:00
Guillermo Eijo
cbbf882ea4 Add link to example to README 2020-10-22 22:04:58 -03:00
uhooi
ca1c035094
Update README.md 2020-07-19 19:46:58 +09:00
Aiqiao Yan
66891cb075
Merge pull request #373 from JohnTitor/patch-1
Remove redundant `#` from OCaml/Reason link
2020-07-16 15:43:10 -04:00
Yuki Okushi
c5475843b3
Remove redundant # from OCaml/Reason link 2020-07-16 11:44:16 +09:00
Aiqiao Yan
4aa79d91d3 Rename master to main 2020-07-15 10:36:12 -04:00
Aiqiao Yan
e6c708b5ce React to feedback 2020-05-26 15:31:33 -04:00
Aiqiao Yan
581312be20 Update readme and examples to use v2 2020-05-26 12:48:39 -04:00
Josh Gross
2b83e91661
Add examples for creating a cache key (#312) 2020-05-20 10:54:39 -04:00
Justin Poehnelt
46fead7f5e
docs: add note about branch scope (#307)
* docs: add note about branch scope

* revert change
2020-05-15 13:28:56 -04:00
Shigeki Karita
ddc4681e8d
Add D example. (#303) 2020-05-11 10:24:05 -04:00
Matija Čupić
f00dedfa6c
Use checkout@v2 in README example (#258) 2020-04-16 11:50:47 -04:00
Josh Gross
f60097cd16
Fix Lerna Example (#242)
* Fix lerna example

* Fix yaml spacing
2020-04-02 10:35:07 -04:00