Commit Graph

119 Commits

Author SHA1 Message Date
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
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
b63536828e there as well ;) 2023-01-19 21:08:05 +01:00
cd2aaa9df8 chore: Fix syntax error typo 2023-01-19 21:04:46 +01:00
003f5452bf Merge branch 'main' into update-docs 2023-01-12 16:48:49 +05:30
76ee6bdfdc Merge branch 'main' into pdotl-patch-1 2023-01-12 16:07:16 +05:30
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
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
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
1f414295fe Fixed broken link (#1057) 2023-01-05 12:14:32 +05:30
84e54000da Merge remote-tracking branch 'origin/main' into feature/add_mint_example 2022-12-29 22:27:37 +09:00
d0e7eb01c9 Merge branch 'main' into update-docs 2022-12-29 13:29:36 +05:30
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
d70353d8a4 📝 #1045 update using the set-output command is deprecated 2022-12-26 07:12:46 +01:00
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
9b0be58822 Release compression related changes for windows (#1039)
* Release compression related changes for windows

* Update license
2022-12-23 11:49:17 +05:30
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
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
3ff04605d3 Updated link for cache segment download info 2022-11-16 14:44:08 +05:30
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
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
14f2d18ea2 Moved recommendation to skipping steps section 2022-10-26 11:15:05 +00:00
5294b3f306 Update README.md 2022-10-19 00:41:06 +05:30
2b04a41915 timeout env var key is not correct in README.md (#959) 2022-10-18 10:56:49 +05:30
862fc14188 Update README.md 2022-10-04 15:10:37 +05:30
f85d12c3b2 Merge branch 'main' into patch-1 2022-10-03 10:16:35 +02:00
98044e486f Update README.md 2022-10-03 10:15:54 +02:00
12681847c6 Update README.md (#936) 2022-09-23 17:15:41 +05:30
3238536a48 Update README.md 2022-09-22 10:50:41 +02:00
9f98a2f01c Merge branch 'main' into pdotl/readme-update-1 2022-08-30 14:02:27 +05:30
471fb0c87e Move workarounds to a different file 2022-08-30 08:24:10 +00:00
0c180092a2 Add a note about path expansion on Windows. 2022-08-29 17:16:27 +05:30
a057257949 Add cross-os caching to the zstd workaround section. 2022-08-26 09:00:35 +00:00
7b5e3aaf23 Move remaining section of Cache segment restore timeout 2022-08-25 13:18:15 +00:00
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
7e7820edca Move Cache segment restore timeout to Known practices and workarounds 2022-08-25 05:52:10 +00:00
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
8a9a57869f Update README.md 2022-08-23 15:20:27 +05:30
fb1d96e3ff Update README.md 2022-08-23 13:19:05 +05:30
d49b6bb21d Updated actions/cache toolkit dep to v3.0.4 2022-08-18 14:13:31 +00:00
23d218be27 Add section for good practices 2022-08-14 14:35:33 +05:30
33a923d660 Added release information 2022-08-09 16:48:03 +00:00
318935ef66 Update README and RELEASES 2022-08-04 10:37:56 +00:00
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
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
8829e97be1 Update README.md
Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
2022-06-27 10:48:52 +05:30
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
02be3a9c73 fixed bad yaml in README example 2022-06-08 21:43:57 +02:00
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
d0a54b996c Fixed typo 2022-06-07 07:14:00 +00:00