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

adr-tools: init at 3.0.0 #57901

Closed
wants to merge 2 commits into from
Closed

adr-tools: init at 3.0.0 #57901

wants to merge 2 commits into from

Conversation

@edibopp
Copy link
Contributor

@edibopp edibopp commented Mar 19, 2019

Motivation for this change

adr-tools is a useful command-line utility for working with architecture decision records. This PR adds it to nixpkgs.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
  • Built on platform(s)
    • NixOS
    • macOS
    • Ubuntu on WSL
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nox --run "nox-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Assured whether relevant documentation is up to date
  • Fits CONTRIBUTING.md.

pkgs/tools/misc/adr-tools/default.nix Outdated Show resolved Hide resolved
pkgs/tools/misc/adr-tools/default.nix Outdated Show resolved Hide resolved
pkgs/tools/misc/adr-tools/default.nix Outdated Show resolved Hide resolved
@edibopp
Copy link
Contributor Author

@edibopp edibopp commented Mar 23, 2019

I addressed @nlewo's requests. Also the tests are running now since 47aa0c1, which is good, as it helped me discover missing dependencies for some subcommands.

@edibopp
Copy link
Contributor Author

@edibopp edibopp commented Mar 23, 2019

There are still issues with some of the commands though, which have to be fixed.

@edibopp
Copy link
Contributor Author

@edibopp edibopp commented Mar 29, 2020

I had almost forgotten this PR… anyway, I have checked the issues and I believe this is an upstream problem about missing usage information on adr-link.

I have squashed the commits and rebased to current master, seems to work fine. Ready to merge from my point of view.

@Moredread
Copy link
Contributor

@Moredread Moredread commented Mar 29, 2020

@GrahamcOfBorg build adr-tools

propagatedBuildInputs = [ getopt bashInteractive ];

buildPhase = ''
patchShebangs src/
Copy link
Contributor

@Moredread Moredread Mar 29, 2020

I think this done automatically, or is this needed for the check phase?

Copy link
Contributor Author

@edibopp edibopp Apr 2, 2020

The tests fail without this buildPhase. They should though as the shebangs will still read #!/bin/bash afterwards. So it seems it is not done automatically.

doCheck = true;

checkPhase = ''
make check
Copy link
Contributor

@Moredread Moredread Mar 29, 2020

Isn't this the default?

Copy link
Contributor Author

@edibopp edibopp Apr 2, 2020

Yes, it does say so in the docs, but when I leave it out, the tests do not run.

pkgs/tools/misc/adr-tools/Makefile.patch Outdated Show resolved Hide resolved
Copy link
Contributor

@Moredread Moredread left a comment

LGTM

@stale
Copy link

@stale stale bot commented Sep 30, 2020

Hello, I'm a bot and I thank you in the name of the community for your contributions.

Nixpkgs is a busy repository, and unfortunately sometimes PRs get left behind for too long. Nevertheless, we'd like to help committers reach the PRs that are still important. This PR has had no activity for 180 days, and so I marked it as stale, but you can rest assured it will never be closed by a non-human.

If this is still important to you and you'd like to remove the stale label, we ask that you leave a comment. Your comment can be as simple as "still important to me". But there's a bit more you can do:

If you received an approval by an unprivileged maintainer and you are just waiting for a merge, you can @ mention someone with merge permissions and ask them to help. You might be able to find someone relevant by using Git blame on the relevant files, or via GitHub's web interface. You can see if someone's a member of the nixpkgs-committers team, by hovering with the mouse over their username on the web interface, or by searching them directly on the list.

If your PR wasn't reviewed at all, it might help to find someone who's perhaps a user of the package or module you are changing, or alternatively, ask once more for a review by the maintainer of the package/module this is about. If you don't know any, you can use Git blame on the relevant files, or GitHub's web interface to find someone who touched the relevant files in the past.

If your PR has had reviews and nevertheless got stale, make sure you've responded to all of the reviewer's requests / questions. Usually when PR authors show responsibility and dedication, reviewers (privileged or not) show dedication as well. If you've pushed a change, it's possible the reviewer wasn't notified about your push via email, so you can always officially request them for a review, or just @ mention them and say you've addressed their comments.

Lastly, you can always ask for help at our Discourse Forum, or more specifically, at this thread or at #nixos' IRC channel.

@edibopp
Copy link
Contributor Author

@edibopp edibopp commented Oct 1, 2020

Closing this, as I no longer have a need for this tool and the upstream repository looks unmaintained.

@edibopp edibopp closed this Oct 1, 2020
@edibopp edibopp deleted the adr-tools branch Oct 1, 2020
@edibopp edibopp restored the adr-tools branch Oct 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants