Skip to content

Conversation

@colemickens
Copy link
Member

Description

The README needs more attention, but I wanted to get this pushed up to try and test E2E with it, as it is.

Checklist
  • Tested changes against a test repository
  • Added or updated relevant documentation (leave unchecked if not applicable)
  • (If this PR is for a release) Updated README to point to the new tag (leave unchecked if not applicable)

@colemickens colemickens force-pushed the colemickens/fhca branch 11 times, most recently from 1187063 to 378c6fe Compare January 17, 2025 17:48
@lucperkins
Copy link
Member

@colemickens I'm still seeing a fair number of references to MNC, for example in package.json. Would be worthwhile to git grep magic or some such and take care of those now (or save for a separate PR).

@colemickens colemickens marked this pull request as ready for review January 17, 2025 17:51
@colemickens
Copy link
Member Author

Thanks @lucperkins, definitely patched up a few more. The remaining ones, I think, are "correct" references to magic-nix-cache the binary specifically.

README.md Outdated
| `source-revision` | The revision of `nix-magic-nix-cache` to use. Conflicts with all other `source-*` options. | | |
| `source-tag` | The tag of `magic-nix-cache` to use. Conflicts with all other `source-*` options. | | |
| `source-url` | A URL pointing to a `magic-nix-cache` binary. Overrides all other `source-*` options. | | |
| `startup-notification-port` | The port magic-nix-cache uses for daemon startup notification. | | 41239 |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit:

Suggested change
| `startup-notification-port` | The port magic-nix-cache uses for daemon startup notification. | | 41239 |
| `startup-notification-port` | The port `magic-nix-cache` uses for daemon startup notification. | | 41239 |

> This means the cache is only usable in CI.
> [Zero to Nix][z2n] has an article on binary caching if you want to [share Nix builds][z2ncache] with users outside of CI.
- Automatic, authenticated integration with GitHub Actions
- Cached paths are available on developer and target machines
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what does "target machines" mean? maybe something like this is better:

Suggested change
- Cached paths are available on developer and target machines
- Cached paths are available wherever you are logged in to FlakeHub, including on developer machines

@grahamc grahamc merged commit 777600e into main Jan 20, 2025
5 checks passed
@grahamc grahamc deleted the colemickens/fhca branch January 20, 2025 19:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants