lix-project/flake-compat
16
2
Fork 4
Code Issues 15 Pull requests Projects Releases Packages Wiki Activity

Update readme #67

Closed
cobaltcause wants to merge 0 commits from cobaltcause/flake-compat:readme into main
pull from: cobaltcause/flake-compat:readme
merge into: lix-project:main
Conversation 2 Commits - Files changed -
cobaltcause commented 2024-11-25 02:37:43 +00:00
Member
Copy link

Remove a stale warning, fix a documentation bug, document another thing.

Remove a stale warning, fix a documentation bug, document another thing.
Because it isn't anymore.
That would break when:

* A flake.lock is created
* The main branch is updated
* The user doesn't have the tarball corresponding to the previous
  version of the main branch in their store

because the hashes won't match.
Some projects like to set `flake = false` for all inputs; this is
good for them to know so they can stay consistent about it.
For consistency/clarity.
This probably only works for forgejo-ish things.
jade reviewed 2024-11-25 18:54:42 +00:00
README.md Outdated
@ -22,2 +7,3 @@
```nix
inputs.flake-compat.url = "https://git.lix.systems/api/v1/repos/lix-project/flake-compat/archive/main.tar.gz";
inputs.flake-compat = {
url = "git+https://git.lix.systems/lix-project/flake-compat";
jade commented 2024-11-25 18:54:24 +00:00
Owner
Copy link

this should be using an archive URL, i think.

https://git.lix.systems/lix-project/flake-compat/archive/main.tar.gz

this should be using an archive URL, i think. https://git.lix.systems/lix-project/flake-compat/archive/main.tar.gz
cobaltcause commented 2024-11-25 19:21:19 +00:00
Author
Member
Copy link

I introduced this in the commit:

don't depend on input that can change

That would break when:

* A flake.lock is created
* The main branch is updated
* The user doesn't have the tarball corresponding to the previous
  version of the main branch in their store

because the hashes won't match.

which is my reasoning for making that change. It's possible I'm wrong about this, though; what do you think?

I introduced this in the commit: ``` don't depend on input that can change That would break when: * A flake.lock is created * The main branch is updated * The user doesn't have the tarball corresponding to the previous version of the main branch in their store because the hashes won't match. ``` which is my reasoning for making that change. It's possible I'm wrong about this, though; what do you think?
cobaltcause commented 2024-11-25 19:26:17 +00:00
Author
Member
Copy link

If the concern is about the value passed to builtins.fetchTarball, that still uses an archive link. The lock object for the git+https input looks like this:

"flake-compat": {
  "flake": false,
  "locked": {
    "lastModified": 1732560995,
    "narHash": "sha256-ZWB9T9BdjXibkwtw9RwBCKTHZmsn5NTfxWzUxLz8B1w=",
    "ref": "main",
    "rev": "33a2aba01c786004d9ab5580ea426f450d4a2238",
    "revCount": 63,
    "type": "git",
    "url": "https://git.lix.systems/lix-project/flake-compat"
  },
  "original": {
    "ref": "main",
    "type": "git",
    "url": "https://git.lix.systems/lix-project/flake-compat"
  }
}

and the builtins.fetchTarball URL is constructed from "${flake-compat.locked.url}/archive/${flake-compat.locked.rev}.tar.gz" which works in my testing.

If the concern is about the value passed to `builtins.fetchTarball`, that still uses an archive link. The lock object for the `git+https` input looks like this: ``` "flake-compat": { "flake": false, "locked": { "lastModified": 1732560995, "narHash": "sha256-ZWB9T9BdjXibkwtw9RwBCKTHZmsn5NTfxWzUxLz8B1w=", "ref": "main", "rev": "33a2aba01c786004d9ab5580ea426f450d4a2238", "revCount": 63, "type": "git", "url": "https://git.lix.systems/lix-project/flake-compat" }, "original": { "ref": "main", "type": "git", "url": "https://git.lix.systems/lix-project/flake-compat" } } ``` and the `builtins.fetchTarball` URL is constructed from `"${flake-compat.locked.url}/archive/${flake-compat.locked.rev}.tar.gz"` which works in my testing.
jade commented 2024-11-26 06:42:12 +00:00
Owner
Copy link

oh, okay. that makes sense and works. sounds good to me.

oh, okay. that makes sense and works. sounds good to me.
jade marked this conversation as resolved
jade closed this pull request 2024-11-26 06:45:34 +00:00
jade commented 2024-11-26 06:45:45 +00:00
Owner
Copy link

haunted?? i merged this and it didnt get marked merged

haunted?? i merged this and it didnt get marked merged
👀 1

Pull request closed

Please reopen this pull request to perform a merge.
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
bug

Something isn't working

  
documentation

Improvements or additions to documentation

  
duplicate

This issue or pull request already exists

  
enhancement

New feature or request

  
good first issue

Good for newcomers

  
help wanted

Extra attention is needed

  
invalid

This doesn't seem right

  
question

Further information is requested

  
wontfix

This will not be worked on

No labels
bug
documentation
duplicate
enhancement
good first issue
help wanted
invalid
question
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: lix-project/flake-compat#67
No description provided.
Delete branch "cobaltcause/flake-compat:readme"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?