Skip to content

Commit ff3f820

Browse files
lucperkinslucperkins
authored
Remove deprecation warnings (#134)
* Remove deprecation warnings * Fix README formatting
1 parent 8b88434 commit ff3f820

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

‎README.md‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,38 @@
11
# Magic Nix Cache
22

3-
> [!WARNING]
4-
> The [Magic Nix Cache will will stop working](https://determinate.systems/posts/magic-nix-cache-free-tier-eol) on **February 1st, 2025** unless you're on [GitHub Enterprise Server](https://github.com/enterprise).
5-
>
6-
> You can upgrade to [FlakeHub Cache](https://flakehub.com/cache) and get **one month free** using the coupon code **`FHC`**.
7-
>
8-
> For more information, read [this blog post](https://determinate.systems/posts/magic-nix-cache-free-tier-eol/).
9-
103
Save 30-50%+ of CI time without any effort or cost.
114
Use Magic Nix Cache, a totally free and zero-configuration binary cache for Nix on GitHub Actions.
125

13-
Add our [GitHub Action][action] after installing Nix, in your workflow, like this:
6+
In your workflow, add our [GitHub Action][action] after installing Nix, like this:
147

158
```yaml
9+
- uses: DeterminateSystems/determinate-nix-action@main
1610
- uses: DeterminateSystems/flakehub-cache-action@main
1711
```
1812
1913
See [Usage](#usage) for a detailed example.
2014
15+
> [!NOTE]
16+
>
17+
> You can upgrade to [FlakeHub Cache][flakehub-cache] and get **one month free** using the coupon code **`FHC`**.
18+
2119
## Why use the Magic Nix Cache?
2220

23-
Magic Nix Cache uses the GitHub Actions [built-in cache][ghacache] to share builds between Workflow runs, and has many advantages over alternatives.
21+
Magic Nix Cache uses the GitHub Actions [built-in cache][gha-cache] to share builds between workflow runs, and has many advantages over alternatives.
2422

25-
1. Totally free: backed by GitHub Actions' cache, there is no additional service to pay for.
26-
1. Zero configuration: add our action to your workflow.
23+
1. **Totally free**. Backed by GitHub Actions' cache, there is no additional service to pay for.
24+
1. **Zero configuration**. Add our Action to your workflow.
2725
That's it.
28-
Everything built in your workflow will be cached.
29-
1. No secrets: Forks and pull requests benefit from the cache, too.
30-
1. Secure: Magic Nix Cache follows the [same semantics as the GitHub Actions cache][semantics], and malicious pull requests cannot pollute your project.
31-
1. Private: The cache is stored in the GitHub Actions cache, not with an additional third party.
26+
Everything built in your workflow is cached.
27+
1. **No secrets**. Forks and pull requests benefit from the cache, too.
28+
1. **Secure**. Magic Nix Cache follows the [same semantics as the GitHub Actions cache][semantics] and malicious pull requests cannot pollute your project.
29+
1. **Private**. The cache is stored in the GitHub Actions cache, not with an additional third party.
3230

33-
> **Note:** the Magic Nix Cache doesn't offer a publicly available cache.
31+
> [!NOTE]
32+
>
33+
> The Magic Nix Cache doesn't offer a publicly available cache.
3434
> This means the cache is only usable in CI.
35-
> [Zero to Nix][z2n] has an article on binary caching if you want to [share Nix builds][z2ncache] with users outside of CI.
35+
> Use [FlakeHub Cache][cache] if you want to [share Nix builds][z2ncache] with users outside of CI.
3636

3737
## Usage
3838

@@ -61,7 +61,7 @@ jobs:
6161
```
6262
6363
That's it.
64-
Everything built in your workflow will be cached.
64+
Everything built in your workflow is cached.
6565
6666
## Usage Notes
6767
@@ -77,7 +77,7 @@ error: unable to download 'http://127.0.0.1:37515/<...>': HTTP error 418
7777
7878
The caching daemon and Nix both handle this gracefully, and won't cause your CI to fail.
7979
When the rate limit is exceeded while pulling dependencies, your workflow may perform more builds than usual.
80-
When the rate limit is exceeded while uploading to the cache, the remainder of those store paths will be uploaded on the next run of the workflow.
80+
When the rate limit is exceeded while uploading to the cache, the remainder of those store paths is uploaded on the next run of the workflow.
8181
8282
## Concepts
8383
@@ -104,7 +104,7 @@ cat action.yml| nix run nixpkgs#yq-go -- '[[ "Parameter", "Description", "Requir
104104
| `diff-store` | Whether or not to diff the store before and after Magic Nix Cache runs. | | `false` |
105105
| `flakehub-api-server` | The FlakeHub API server. | | https://api.flakehub.com |
106106
| `flakehub-cache-server` | The FlakeHub binary cache server. | | https://cache.flakehub.com |
107-
| `flakehub-flake-name` | The name of your flake on FlakeHub. The empty string will autodetect your FlakeHub flake. | | `""` |
107+
| `flakehub-flake-name` | The name of your flake on FlakeHub. The empty string autodetects your FlakeHub flake. | | `""` |
108108
| `listen` | The host and port to listen on. | | 127.0.0.1:37515 |
109109
| `source-binary` | Run a version of the cache binary from somewhere already on disk. Conflicts with all other `source-*` options. | | |
110110
| `source-branch` | The branch of `magic-nix-cache` to use. Conflicts with all other `source-*` options. | | main |
@@ -113,20 +113,20 @@ cat action.yml| nix run nixpkgs#yq-go -- '[[ "Parameter", "Description", "Requir
113113
| `source-tag` | The tag of `magic-nix-cache` to use. Conflicts with all other `source-*` options. | | |
114114
| `source-url` | A URL pointing to a `magic-nix-cache` binary. Overrides all other `source-*` options. | | |
115115
| `startup-notification-port` | The port magic-nix-cache uses for daemon startup notification. | | 41239 |
116-
| `upstream-cache` | Your preferred upstream cache. Store paths in this store will not be cached in GitHub Actions' cache. | | https://cache.nixos.org |
116+
| `upstream-cache` | Your preferred upstream cache. Store paths in this store aren't cached in GitHub Actions' cache. | | https://cache.nixos.org |
117117
| `use-flakehub` | Whether to upload build results to FlakeHub Cache (private beta). | | true |
118118
| `use-gha-cache` | Whether to upload build results to the GitHub Actions cache. | | true |
119119

120+
[action]: https://github.com/DeterminateSystems/magic-nix-cache-action
121+
[attic]: https://github.com/zhaofengli/attic
122+
[colmena]: https://github.com/zhaofengli/colmena
123+
[detsys]: https://determinate.systems
124+
[flakehub-cache]: https://flakehub.com/cache
120125
[gha-cache]: https://docs.github.com/en/rest/actions/cache
121-
[detsys]: https://determinate.systems/
122-
[action]: https://github.com/DeterminateSystems/magic-nix-cache-action/
123126
[installer]: https://github.com/DeterminateSystems/nix-installer/
124-
[ghacache]: https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows
125127
[privacy]: https://determinate.systems/policies/privacy
126-
[telemetry]: https://github.com/DeterminateSystems/magic-nix-cache/blob/main/magic-nix-cache/src/telemetry.rs
127128
[semantics]: https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache
128-
[z2ncache]: https://zero-to-nix.com/concepts/caching#binary-caches
129-
[zhaofeng]: https://github.com/zhaofengli/
130-
[attic]: https://github.com/zhaofengli/attic
131-
[colmena]: https://github.com/zhaofengli/colmena
129+
[telemetry]: https://github.com/DeterminateSystems/magic-nix-cache/blob/main/magic-nix-cache/src/telemetry.rs
132130
[z2n]: https://zero-to-nix.com
131+
[z2ncache]: https://zero-to-nix.com/concepts/caching#binary-caches
132+
[zhaofeng]: https://github.com/zhaofengli

0 commit comments

Comments
 (0)