Commit graph

79 commits

Author SHA1 Message Date
Tim Perry ccaf2d8fb1 Tweak npm example description for cleaner links 2022-05-25 12:00:49 +02:00
Tim Perry 34f9efca11 Simplify the Node.js NPM caching example 2022-05-25 11:58:58 +02:00
Vipul 95f200e41c
Merge pull request #762 from magnetikonline/remove-win-load-app-data
Remove final incorrect instances of `%AppData%` / `%LocalAppData%` from Windows cache examples
2022-05-11 16:14:36 +05:30
Vipul 9c784e290b
Merge pull request #738 from kubo39/fix-dub
[D] Fix: should use dub.selections.json for cache
2022-05-11 16:13:29 +05:30
Ashwin Sangem 7799d864d9
Updated the usage and docs to the major version release. (#770) 2022-03-21 14:31:26 +05:30
Peter Mescalchin 3722efebf1 Remove final incorrect instances of %AppData% / %LocalAppData% for Windows cache examples 2022-03-10 10:44:10 +11:00
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 6535c5fb5f Regenerated examples.md TOC 2022-02-24 16:36:38 +11:00
Peter Mescalchin 341e6d75d9
Merge branch 'actions:main' into fix-golang-windows-example 2022-02-24 16:28:28 +11:00
Vipul ab4bea262c
Merge pull request #567 from yuichkun/fix-typo-in-lerna-example
Fix typo of cache path in Lerna example
2022-02-23 11:24:07 +05:30
Yuichi Yogo 7772fcab79 remove unnecessary sub directory from search path 2022-02-23 12:39:46 +09:00
Malo Bourgon 2c7b30f330 Add example for Haskell Stack 2022-02-22 10:21:09 -08:00
Hiroki Noda 5074380beb [D] Fix: should use dub.selections.json for cache 2022-02-12 03:17:32 +09:00
Jheyson Saavedra de7c17c6a9
chore: add Deno cache example 2022-01-15 19:33:29 -05:00
Joachim Breitner c64c5261d3
Fix syntax 2021-12-30 11:54:15 +01:00
Joachim Breitner 4e8aa1cc93
Improve Haskell example
as proposed in https://github.com/actions/cache/issues/555
2021-12-29 20:50:37 +01:00
Manuel Roth 67b6d52d50
(R renv) Remove unused renv-cache-path variable (#663) 2021-10-22 11:32:54 -04:00
Manuel Roth 92f67a4829
(R renv) Fix Renv package cache location in examples (#660)
* (R renv) Fix Renv package cache location in examples

* (R env) Update getting Renv package cache location

* (R env) Set renv package cache location using RENV_PATHS_ROOT environment variable
2021-10-22 10:22:58 -04:00
Peter Mescalchin 447f0fd1d3 Chomp some markdown whitespace 2021-09-26 22:10:48 +10:00
Peter Mescalchin 795a8f09a9 Fixed Windows Golang cache paths in example 2021-09-26 22:05:48 +10:00
andrewdotn 5807af2642
Fix bugs in example of how to use with pipenv (#607)
* Fix bugs in example of how to use with pipenv

The current example of how to use `@actions/cache` with pipenv has two
problems:

 1. The cached virtualenv that pipenv creates has `bin/python` as a symlink
    into paths like `/opt/hostedtoolcache/Python/3.7.11` that explicitly
    include the patch version of python. When the cache is restored onto a
    machine running a slightly different version of python, e.g., when
    GitHub upgrades its runners from python 3.7.10 to 3.7.11, then any
    attempt to run python in the workflow mysteriously fails with errors
    like `Failed to load paths: /bin/sh: 1: /home/runner/.local/share/virtualenvs/myrepo-sOIMCiTO/bin/python: not found`.

    Therefore the patch version of python should be included in the cache
    key.

 2. `pipenv --install` has the unfortunate behaviour of not cleaning out
    any pre-existing packages. That is, if the `Pipfile` first contains
    dependencies on `foo` and `bar`, and then you remove `bar` from the
    `Pipfile` and run `pipenv install` again, `bar` is still included in
    the virtualenv.

    This can cause false-positive test failures: when a dependency is
    removed from the `Pipfile` but there is still code that relies on the
    removed dependency, tests can still pass if the dependency comes from
    the cache based on a previous revision of `Pipfile.lock`.

    Therefore `restore-keys` should not be set.

This PR attempts to address both of these issues.

* Explain why setup-python is included in example
2021-07-15 14:37:10 -04:00
Peter Mescalchin 0638051e9a
Golang example tweak - add go-build path - rebuild page TOC (#577) 2021-06-01 08:39:29 -05:00
Alex Tokarev cc2d767a72
Update Rust directories recommended for caching (#433)
This commit applies the suggestion from The Cargo Book:
https://doc.rust-lang.org/cargo/guide/cargo-home.html#caching-the-cargo-home-in-ci
2021-05-21 12:41:57 -05:00
Daniel Kuschny 2fa955d825
Update examples.md (#588)
Extend gradle notes.
2021-05-13 14:40:34 -05:00
Yuichi Yogo 4762de4681 simplify path in lerna example 2021-04-21 02:47:03 +09:00
kalin 3a696372f2
elixir typo - stray parenthesis (#569) 2021-04-20 08:51:44 -05:00
Wojtek Mach 366e5ba022
Update cache key for Elixir (#568) 2021-04-19 08:42:01 -05:00
Yuichi Yogo 12ed05f49a Fix typo of cache path in Lerna example 2021-04-17 12:35:30 +09:00
Jonathan Clem 981fa981ed
Merge pull request #469 from ericmj/patch-1
Also cache _build for Elixir
2021-03-31 10:46:31 -04:00
Pradyun Gedam 4498c5b4d8
Drop the example based on using pip's internals (#519)
pip's documentation explicitly states to not use `import pip`:

> While it is implemented in Python, and so is available from your Python code via
> `import pip`, you must not use pip’s internal APIs in this way.

This example is in direct contradiction with the documentation's guidance and, thus, has
been removed.
2021-03-29 17:34:02 -04:00
Benoit Daloze 1bfe3accb3 Recommend ruby/setup-ruby's bundler-cache: true option
Manually caching gems has many issues:
* Not working if there is no Gemfile.lock but only a Gemfile
* Not having the OS version in the key, which might cause binary incompatibility with system libraries of different ABI version.
* Not taking the Ruby version in account.
* Not taking the Ruby ABI version of development builds into accounts, which cannot be done with a key, but needs the commit hash.
* Using restore-keys would grow the cache over time and have extra gems in the cache.
* Those reasons are summarized in https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby#caching-bundle-install-manually
2021-01-28 12:52:25 +01:00
Konrad Pabjan 354332455a
Merge pull request #434 from DanielHabenicht/patch-1
Update examples.md for NPM
2021-01-14 17:22:53 +01:00
Odín del Río e64ab303d1
Improved gradle cache key calculation example 2021-01-13 22:09:00 +01:00
Chris Patterson 72f66cfa6d
Added a cache example when using matrix 2021-01-12 13:29:18 -05:00
Eric Meadows-Jönsson 62a4d75442
Also cache _build for Elixir 2020-11-24 15:52:21 +01:00
Guillermo Eijo 4557c6a937 Add example for python pipenv 2020-10-22 21:35:30 -03:00
DanielHabenicht 19530ba135
Update examples.md 2020-10-14 02:51:53 +02:00
Shafiq Jetha 8b407f7777
Grammar fix (#405) 2020-09-08 13:10:51 -04:00
Noam Tamim 59a8d125e7
Fix indentation in last pip example 2020-08-05 12:29:52 +03:00
Aiqiao Yan 4978dc4f31
Merge pull request #358 from gaerfield/patch-1
fixes actions/cache#244
2020-07-16 15:48:28 -04:00
Aiqiao Yan 5c77066753
Merge pull request #359 from JLHwung/patch-1
add Yarn 2 cache example
2020-07-16 15:41:08 -04:00
Aiqiao Yan 4aa79d91d3 Rename master to main 2020-07-15 10:36:12 -04:00
Huáng Jùnliàng 5474af707f
add Yarn 2 cache example 2020-07-02 09:43:52 -04:00
gaerfield 591646a21e
fixes actions/cache#244 2020-07-01 10:30:03 +02:00
Marcono1234 eed9cfe64d
Add name for Maven example (#341) 2020-06-18 13:37:50 -04:00
Josh Gross 984ce638f0
Add note about using setup-node before cache (#351) 2020-06-15 15:55:57 -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
Shigeki Karita ddc4681e8d
Add D example. (#303) 2020-05-11 10:24:05 -04:00