Fetchgit{,hub}: add tag argument

Atemu · November 28, 2024, 12:24pm

fetchgit{,hub}: add tag argument

NixOS:master ← Atemu:fetchgit-tag

opened 07:14PM - 14 Nov 24 UTC

It's become a common pattern to use `rev = "refs/tags/${version}"` rather than j…ust `rev = version` to ensure that the tag gets fetched rather than a branch that has the same name. This is done using boilerplate though, so let's add a simple abstraction for fetching tags instead. ~~The first two commits are from https://github.com/NixOS/nixpkgs/pull/355685 which should be merged first. Please review those separately.~~ This should be backported as it's a non-breaking addition and because people will likely want to make use of this in changes which they want to backport.  ## Things done - Built on platform(s) - [ ] x86_64-linux - [ ] aarch64-linux - [ ] x86_64-darwin - [ ] aarch64-darwin - For non-Linux: Is sandboxing enabled in `nix.conf`? (See [Nix manual](https://nixos.org/manual/nix/stable/command-ref/conf-file.html)) - [ ] `sandbox = relaxed` - [ ] `sandbox = true` - [ ] Tested, as applicable: - [NixOS test(s)](https://nixos.org/manual/nixos/unstable/index.html#sec-nixos-tests) (look inside [nixos/tests](https://github.com/NixOS/nixpkgs/blob/master/nixos/tests)) - and/or [package tests](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md#package-tests) - or, for functions and "core" functionality, tests in [lib/tests](https://github.com/NixOS/nixpkgs/blob/master/lib/tests) or [pkgs/test](https://github.com/NixOS/nixpkgs/blob/master/pkgs/test) - made sure NixOS tests are [linked](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md#linking-nixos-module-tests-to-a-package) to the relevant packages - [ ] Tested compilation of all packages that depend on this change using `nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD"`. Note: all changes have to be committed, also see [nixpkgs-review usage](https://github.com/Mic92/nixpkgs-review#usage) - [ ] Tested basic functionality of all binary files (usually in `./result/bin/`) - [25.05 Release Notes](https://github.com/NixOS/nixpkgs/blob/master/nixos/doc/manual/release-notes/rl-2505.section.md) (or backporting [24.11](https://github.com/NixOS/nixpkgs/blob/master/nixos/doc/manual/release-notes/rl-2411.section.md) and [25.05](https://github.com/NixOS/nixpkgs/blob/master/nixos/doc/manual/release-notes/rl-2505.section.md) Release notes) - [ ] (Package updates) Added a release notes entry if the change is major or breaking - [ ] (Module updates) Added a release notes entry if the change is significant - [ ] (Module addition) Added a release notes entry if adding a new NixOS module - [ ] Fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).  --- Add a :+1: [reaction] to [pull requests you find important]. [reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/ [pull requests you find important]: https://github.com/NixOS/nixpkgs/pulls?q=is%3Aopen+sort%3Areactions-%2B1-desc

I post this here not really for code review but because I think this would be relevant for pretty much anyone who maintains a package and want to double check that it’s indeed desirable and that there isn’t some fundamental flaw.

waffle8946 · November 28, 2024, 3:26pm

It could reduce the amount of confusing boilerplate for new contributors. However I do find it a little confusing that specifying both rev and tag is permissible, an assertion/warning might prevent someone doing that unintentionally.

Atemu · November 28, 2024, 4:55pm

The trouble with that is that it gets harder/hairier to pass args fromFetchFromGitHub to fetchgit.

Atemu · December 5, 2024, 4:21pm

The code is now merged and can be used in Nixpkgs. The backport will follow shortly; I’ll let one unstable eval pass before merging it.