Examples: use GitHub cargo2nix URL, not relative path #355
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The users are shown one thing and told to do another. The use of parent directories in flake URLs is unreliable (that's why `get-flake` exists) and should be avoided in examples. Referring to the parent directory creates a circular dependency in `flake.lock` files. `nix flake lock` keeps changing the sources every time it's run because the `flake.lock` files in the examples affect the checksum of the parent flake, which in turn goes to `flake.lock` in the examples. With GitHub references, the locks would get out of date only when a new commit is merged to the branch used in the URL.
proski
changed the title
|
This needs some care, as we probably don't want to endorse a broken branch. Either the ref branch should be the current branch, or it should be the latest release. |
|
Also, the examples are used in CI. The CI should be using the current code under test, not a GitHub reference. |
|
Design considerations are just that local testing and that CI is useful / works. Version mismatch between test workspace Cargo.nix and the cargo overlay will often cause breakage. Perhaps the flakes should be overridden via automation and scripts. At the time of CI, the rev under test is available via git. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The users are shown one thing and told to do another.
The use of parent directories in flake URLs is unreliable (that's why
get-flakeexists) and should be avoided in examples.Referring to the parent directory creates a circular dependency in
flake.lockfiles.nix flake lockkeeps changing the sources every time it's run because theflake.lockfiles in the examples affect the checksum of the parent flake, which in turn goes toflake.lockin the examples.With GitHub references, the locks would get out of date only when a new commit is merged to the branch used in the URL.