Commit Graph

97 Commits

Author SHA1 Message Date
todgru
104f95683b update documentation to use <action>@v4 2024-01-26 14:08:22 -08:00
Michael Vorburger ⛑️
6f1f1e10f3
Clarify that macos-latest image has bazelisk 2023-03-13 14:26:31 +01:00
Michael Vorburger ⛑️
4b8460cbff
Create separate Linux/macOS examples for Bazel 2023-03-13 10:52:18 +01:00
Michael Vorburger
ef11f54eee Fix example for Bazel 2023-03-11 19:54:11 +01:00
David Bernard
4b381be638 Add example for Bazel 2023-03-11 19:21:37 +01: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
Tanuj Kumar Mishra
003f5452bf
Merge branch 'main' into update-docs 2023-01-12 16:48:49 +05:30
uhooi
d6217569d5 Update Mint example 2022-12-29 22:28:56 +09:00
uhooi
84e54000da Merge remote-tracking branch 'origin/main' into feature/add_mint_example 2022-12-29 22:27:37 +09:00
SIGUI Kessé Emmanuel
d70353d8a4 📝 #1045 update using the set-output command is deprecated 2022-12-26 07:12:46 +01:00
A. Pascual
dc097e3bb9
Update examples.md (#1026)
According with the behavior description the id of "Get npm cache directory" must be "npm-cache-dir".

I checked it in my own project.
2022-12-11 12:49:22 +05:30
Deepak Dahiya
fb86cbf360
Updated node example (#1008)
* Updated node example

* Update examples.md
2022-12-07 14:55:01 +05:30
ysato
0ff0597934
Update examples.md (#920) 2022-09-29 10:27:49 +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
Mike Pilgrem
d25c51bbfd Adapt existing Haskell Stack example for Windows
The default `STACK_ROOT` is `~/.stack` only on Unix-like operating systems. On Windows, the default is `%APPDATA%/stack` (usually `%HOME%\AppData\Roaming\stack`).

On Unix-like OSs, Stack stores GHC and other tools in a `programs` directory in the `STACK_ROOT`. On Windows, Stack stores those tools and MSYS2 in `%LOCALAPPDATA%\Programs\stack` (usually `%HOME%\AppData\Local\Programs\stack`).
2022-06-21 13:15:08 +01:00
Leandro Ostera
acace7fa1b
Merge branch 'main' into patch-1 2022-06-06 14:26:51 +02:00
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