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

gfold: init at 3.0.0 #153893

Merged
merged 2 commits into from
Jan 12, 2022
Merged

gfold: init at 3.0.0 #153893

merged 2 commits into from
Jan 12, 2022

Conversation

shanesveller
Copy link
Contributor

@shanesveller shanesveller commented Jan 7, 2022

Motivation for this change

Introduces a new package, gfold, which is a CLI allowing bulk read-only review of the local git state of a tree of folders containing cloned/bare repositories.

Example usage:

gfold [--classic] path/to/some/tree

Example output:

# default
nixpkgs ~ /path/to/nixpkgs
  clean (shanesveller/gfold-3.0)
  git@github.com:shanesveller/nixpkgs.git
  <email>
# --classic
nixpkgs  clean  shanesveller/gfold-3.0  git@github.com:shanesveller/nixpkgs.git
Things done
  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandbox = true set in nix.conf? (See Nix manual)
  • 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/)
  • 22.05 Release Notes (or backporting 21.11 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
    • (Release notes changes) Ran nixos/doc/manual/md-to-db.sh to update generated release notes
  • Fits CONTRIBUTING.md.

@shanesveller
Copy link
Contributor Author

Result of nixpkgs-review pr 153893 run on x86_64-darwin 1

1 package built:
  • gfold

@shanesveller
Copy link
Contributor Author

Result of nixpkgs-review pr 153893 run on x86_64-linux 1

1 package built:
  • gfold

@shanesveller shanesveller marked this pull request as ready for review January 7, 2022 21:45
@shanesveller
Copy link
Contributor Author

The utility shells out to the Git CLI during execution - is makeWrapper the best preferred approach for this concern?

Comment on lines 17 to 18
description =
"CLI tool to help keep track of your Git repositories, written in Rust";
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
description =
"CLI tool to help keep track of your Git repositories, written in Rust";
description = "A tool to help keep track of your Git repositories, written in Rust";

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @AndersonTorres, thanks for the review. I've changed this with your suggestion at 9a536f4d09f6de919790224a156e110f3312a29b.

Just to help me adapt as a new contributor, was this feedback more oriented around the phrasing or the newline? I have my editor using nixfmt by default and nixpkgs-fmt instead didn't seem to propose any diffs on the previous version.

Copy link
Member

Choose a reason for hiding this comment

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

The newline, primarily. It is weird to look a description not in the same line.

I suggested the new phrasing because I thought that the old one would break the 80-column limit. I would even suggest to remove the , written in Rust, but I think it would be excessive.

No worries, this is mostly stylistical.

@AndersonTorres
Copy link
Member

The utility shells out to the Git CLI during execution - is makeWrapper the best preferred approach for this concern?

Yes. If it needs the git tool in $PATH, then it needs to be wrapped.

@AndersonTorres
Copy link
Member

AndersonTorres commented Jan 9, 2022

Squash those two latest commits into one.

@shanesveller
Copy link
Contributor Author

I've squashed the two commits as requested, and I'm happy to address any further feedback as it arises.

Copy link
Member

@AndersonTorres AndersonTorres left a comment

Choose a reason for hiding this comment

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

LGTM, LGTBorg.

It takes some guts to start contributing to Nixpkgs with Rust packages!

@legendofmiracles
Copy link
Contributor

Result of nixpkgs-review pr 153893 run on x86_64-linux 1

1 package built:
  • gfold

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants