mirrors/magic-nix-cache
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Merge pull request #18 from DeterminateSystems/fix-readme

Browse source 
Small README fix
This commit is contained in:
Graham Christensen 2023-06-26 15:19:44 -04:00 committed by GitHub
parent e48ed814ae 9e94b0d1c9
commit 375d12266a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -12,6 +12,7 @@ Add our [GitHub Action][action] after installing Nix, in your workflow, like thi
See [Usage](#usage) for a detailed example. See [Usage](#usage) for a detailed example.
## Why use the Magic Nix Cache? ## Why use the Magic Nix Cache?
Magic Nix Cache uses the GitHub Actions [built-in cache][ghacache] to share builds between Workflow runs, and has many advantages over alternatives. Magic Nix Cache uses the GitHub Actions [built-in cache][ghacache] to share builds between Workflow runs, and has many advantages over alternatives.
1. Totally free: backed by GitHub Actions' cache, there is no additional service to pay for. 1. Totally free: backed by GitHub Actions' cache, there is no additional service to pay for.
@ -22,9 +23,9 @@ Magic Nix Cache uses the GitHub Actions [built-in cache][ghacache] to share buil
1. Secure: Magic Nix Cache follows the [same semantics as the GitHub Actions cache][semantics], and malicious pull requests cannot pollute your project. 1. Secure: Magic Nix Cache follows the [same semantics as the GitHub Actions cache][semantics], and malicious pull requests cannot pollute your project.
1. Private: The cache is stored in the GitHub Actions cache, not with an additional third party. 1. Private: The cache is stored in the GitHub Actions cache, not with an additional third party.
> **Note:** the Magic Nix Cache doesn't offer a publically available cache. > **Note:** the Magic Nix Cache doesn't offer a publicly available cache.
> This means the cache is only usable in CI. > This means the cache is only usable in CI.
> Zero to Nix has an article on binary caching if you want to [share Nix builds][z2ncache] with users outside of CI. > [Zero to Nix][z2n] has an article on binary caching if you want to [share Nix builds][z2ncache] with users outside of CI.
## Usage ## Usage
@ -71,7 +72,7 @@ When the rate limit is exceeded while uploading to the cache, the remainder of t
This project depends on the GitHub Actions Cache API. This project depends on the GitHub Actions Cache API.
For local development, see `gha-cache/README.md` for more details on how to obtain the required tokens. For local development, see `gha-cache/README.md` for more details on how to obtain the required tokens.
``` ```shell
cargo run -- -c creds.json --upstream https://cache.nixos.org cargo run -- -c creds.json --upstream https://cache.nixos.org
cargo build --release --target x86_64-unknown-linux-musl cargo build --release --target x86_64-unknown-linux-musl
cargo build --release --target aarch64-unknown-linux-musl cargo build --release --target aarch64-unknown-linux-musl
@ -80,6 +81,7 @@ nix-store --store $PWD/test-root --extra-substituters 'http://localhost:3000' --
``` ```
## Acknowledgement ## Acknowledgement
Magic Nix Cache is a collaboration with [Zhaofeng Li][zhaofeng]. Magic Nix Cache is a collaboration with [Zhaofeng Li][zhaofeng].
Zhaofeng is a major contributor to the Nix community, having authored [Attic][attic] and [Colmena][colmena]. Zhaofeng is a major contributor to the Nix community, having authored [Attic][attic] and [Colmena][colmena].
We'd like to express our deep gratitude to Zhaofeng for his tremendous work on this project. We'd like to express our deep gratitude to Zhaofeng for his tremendous work on this project.
@ -124,3 +126,5 @@ You can read the full privacy policy for [Determinate Systems][detsys], the crea
[zhaofeng]: https://github.com/zhaofengli/ [zhaofeng]: https://github.com/zhaofengli/
[attic]: https://github.com/zhaofengli/attic [attic]: https://github.com/zhaofengli/attic
[colmena]: https://github.com/zhaofengli/colmena [colmena]: https://github.com/zhaofengli/colmena
[z2n]: https://zero-to-nix.com