Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

snx-rs: 2.2.3 -> 2.9.0 #376344

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

snx-rs: 2.2.3 -> 2.9.0 #376344

wants to merge 2 commits into from

Conversation

Shavyn
Copy link

@Shavyn Shavyn commented Jan 24, 2025

This is only a version bump of the snx-rs package as the version in nixpkgs (2.2.3) didn't support a feature added later I needed.

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)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • 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
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 25.05 Release Notes (or backporting 24.11 and 25.05 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.

Add a 👍 reaction to pull requests you find important.

@NixOSInfra NixOSInfra added the 12. first-time contribution This PR is the author's first one; please be gentle! label Jan 24, 2025
@github-actions github-actions bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1 10.rebuild-linux: 1-10 labels Jan 24, 2025
@nbraud
Copy link
Contributor

nbraud commented Jan 24, 2025

nixpkgs-review result

Generated using nixpkgs-review.

Command: nixpkgs-review pr 376344

@nbraud
Copy link
Contributor

nbraud commented Jan 24, 2025

nixpkgs-review result

Generated using nixpkgs-review.

Command: nixpkgs-review pr 376344


x86_64-linux

✅ 1 package built:
  • snx-rs

Copy link
Contributor

@nbraud nbraud left a comment

Choose a reason for hiding this comment

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

Seems good.

@nbraud nbraud added the 12.approvals: 1 This PR was reviewed and approved by one reputable person label Jan 24, 2025
@nbraud
Copy link
Contributor

nbraud commented Jan 24, 2025

@Shavyn This package is currently unmaintained (meta.maintainers == []) so it might not be kept up-to-date 😬
Since you are using it, would you volunteer for maintainership?

I'd also suggest setting up automatic updates so @r-ryantm will automatically generate PRs and notify the maintainer(s)

Copy link
Contributor

@Adda0 Adda0 left a comment

Choose a reason for hiding this comment

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

Before merging, the commit history should be definitely cleaned up: squashing the commits, removing the merged from ... commits, ideally keeping only one commit, which can then have additional information in the commit long description part from the current commits, if you want.

@Adda0
Copy link
Contributor

Adda0 commented Jan 24, 2025

nixpkgs-review result

Generated using nixpkgs-review.

Command: nixpkgs-review pr 376344


x86_64-linux

✅ 1 package built:
  • snx-rs

Reviewed points

✅ 12 | ❔ 1 | 🔴 1
  • Package name fits the guidelines.
  • Package version fits the guidelines.
  • The commit text fits the guidelines.
  • Package maintainers are notified.
    • The continuous integration system will make GitHub notify users based on the submitted changes, but it can happen that it misses some of the package maintainers.
  • meta field information fits the guidelines and contain the correct information:
    • License can change with version updates, so it should be checked to match the upstream license.
    • If the package has no maintainer, a maintainer must be set. This can be the update submitter or a community member that accepts to take maintainership of the package.
  • The code contains no typos.
  • The package builds locally on x86_64-linux.
  • All executables run on x86_64-linux.
  • All executables tested on x86_64-linux.
  • All depending packages build.
  • Patches have a comment describing either the upstream URL or a reason why the patch wasn't upstreamed.
  • Patches that are remotely available are fetched rather than vendored.
Possible improvements
Comments

The package builds and runs, but I cannot test the functionality of the package.

@Shavyn
Copy link
Author

Shavyn commented Jan 24, 2025

@nbraud thanks for the reply. I'll consider adding the automation and the possibility to maintain the package (my knowledge of Nix is next to zero).
@Adda0 thanks for your contribution. As you can guess I'm a newbie and this is all new to me. I'm learning how to clean up this mess.

@Adda0
Copy link
Contributor

Adda0 commented Jan 24, 2025

I looked at the upstream repo. They have a changelog file in there. We should add it to the meta attrset like this:

changelog = "https://github.com/ancwrd1/snx-rs/blob/v${version}/CHANGELOG.md";

Could you make the change while you are at it, too?

@Adda0
Copy link
Contributor

Adda0 commented Jan 24, 2025

@nbraud thanks for the reply. I'll consider adding the automation and the possibility to maintain the package (my knowledge of Nix is next to zero).

Since this project has regular releases on GitHub, adding an update script should be as easy as adding

passthru.updateScript = nix-update-script { };

@Shavyn
Copy link
Author

Shavyn commented Jan 24, 2025

Thanks for all the inputs, as soon as I come back from work I'll have everything (hopefully) sorted.

@nbraud
Copy link
Contributor

nbraud commented Jan 25, 2025

Before merging, the commit history should be definitely cleaned up: squashing the commits, removing the merged from ... commits, ideally keeping only one commit

TBH, that can be accomplished just as well with a squash merge, so I don't see a strong incentive to make people squash the history themselves, especially given that it's then harder for others to see what changed since they last reviewed.

@wegank wegank removed the 12.approvals: 1 This PR was reviewed and approved by one reputable person label Jan 25, 2025
@Shavyn Shavyn force-pushed the pkg/snx-rs branch 2 times, most recently from 558feb8 to a765728 Compare January 26, 2025 15:48
@Shavyn
Copy link
Author

Shavyn commented Jan 26, 2025

I managed to:

  • add changelog to meta informations
  • remove the test disabling
  • (hopefully) squash commits

Sorry it took me so long. For that reason I'm hesitating volunteering to maintain the package. Let me train a little bit more :).

@Adda0
Copy link
Contributor

Adda0 commented Jan 27, 2025

TBH, that can be accomplished just as well with a squash merge, so I don't see a strong incentive to make people squash the history themselves, especially given that it's then harder for others to see what changed since they last reviewed.

True, but it has disadvantages that, IMO, heavily outweigh its usefulness:

  1. This puts the responsibility to the committers to perform another check before merging and carefully think whether squashing the commits makes sense for each PR.
  2. This prevents separate meaningful commits when it really makes sense: PRs with changes different from simple updates. Again, the committers must spend more time reviewing each PR.
  3. One cannot separate the update to the maintainer list from the update to a package.

Personally, I prefer to make the job of committers as easy as possible, and put the responsibility of preparing the PR to an ideal state to each contributor.

The only real disadvantage I see here is, as you point out, that the diff for the previous reviewers gets mangled. But here we are usually not reviewing "program" code spanning multiple source files, but "only" one "configuration" file which would get modified anyway, so unless you review the specific new commits separately, you will see that the entire file has changed, anyway.

@Adda0
Copy link
Contributor

Adda0 commented Jan 27, 2025

I managed to:

* add changelog to meta informations

* remove the test disabling

* (hopefully) squash commits

Sorry it took me so long. For that reason I'm hesitating volunteering to maintain the package. Let me train a little bit more :).

Thanks. It looks great. In general, one should not merge the master branch into the feature branch (creating the merge commit), but instead rebase onto the master branch. This would result in a single commit built atop the newest commit on the master branch.

@nixos-discourse
Copy link

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/packages-looking-for-a-maintainer/5442/9

@Adda0
Copy link
Contributor

Adda0 commented Jan 27, 2025

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/packages-looking-for-a-maintainer/5442/9

I mentioned that the package is looking for a maintainer. Hopefully someone steps in.

@github-actions github-actions bot added the 8.has: maintainer-list (update) This PR changes `maintainers/maintainer-list.nix` label Jan 27, 2025
@Shavyn
Copy link
Author

Shavyn commented Jan 27, 2025

The latest commit adds what @Adda0 suggested in his review, adds myself as maintainer (wish me good luck). I hope I used the git rebase command correctly instead of merging

Thanks everyone for your help.

Copy link
Contributor

@Adda0 Adda0 left a comment

Choose a reason for hiding this comment

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

Other than the commit for maintainer list update, all seems well. I will do a final rebuild of all binaries soon and if all goes well, I am all for approving the PR. Thank you for the patience with our "demands" and good luck with the maintainership. Hopefully, all will work well with future versions of the package, and there will not be much additional work needed.

And yes, the rebase seems to went well. Great work!

maintainers/maintainer-list.nix Outdated Show resolved Hide resolved
@Shavyn Shavyn force-pushed the pkg/snx-rs branch 2 times, most recently from 966ddb2 to 3095f1d Compare January 28, 2025 09:28
@Adda0
Copy link
Contributor

Adda0 commented Jan 29, 2025

nixpkgs-review result

Generated using nixpkgs-review.

Command: nixpkgs-review pr 376344


x86_64-linux

✅ 1 package built:
  • snx-rs
Comments

All builds and runs, but I cannot test the functionality of the package. The maintainer information is valid. Looks good to me.

@Adda0 Adda0 added the 12.approvals: 1 This PR was reviewed and approved by one reputable person label Jan 29, 2025
@wegank wegank removed the 12.approvals: 1 This PR was reviewed and approved by one reputable person label Feb 1, 2025
@Shavyn
Copy link
Author

Shavyn commented Feb 4, 2025

Removed the (unintentional) merge master commit. Sorry.

@Adda0 Adda0 added the 12.approvals: 1 This PR was reviewed and approved by one reputable person label Feb 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.has: maintainer-list (update) This PR changes `maintainers/maintainer-list.nix` 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 10.rebuild-linux: 1 12.approvals: 1 This PR was reviewed and approved by one reputable person 12. first-time contribution This PR is the author's first one; please be gentle!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants