summaryrefslogtreecommitdiffstats
path: root/pkgs/by-name/ad/adr-tools/package.nix
blob: 2b5ff00c943c0de57b4bee71c5a67d8617cbae1a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
{
  lib,
  stdenv,
  fetchFromGitHub,
  installShellFiles,
  makeWrapper,
  nix-update-script,

  bash,
  bashInteractive,
  coreutils,
  findutils,
  gawk,
  getopt,
  gnugrep,
  gnused,

  # tests
  adr-tools,
  runCommand,
}:

stdenv.mkDerivation (finalAttrs: {
  pname = "adr-tools";
  version = "3.0.0";

  src = fetchFromGitHub {
    owner = "npryce";
    repo = "adr-tools";
    tag = finalAttrs.version;
    hash = "sha256-JEwLn+SY6XcaQ9VhN8ARQaZc1zolgAJKfIqPggzV+sU=";
  };

  nativeBuildInputs = [
    installShellFiles
    makeWrapper
  ];

  buildInputs = [
    # need an interactive interpreter for compgen
    bashInteractive
  ];

  checkInputs = [ getopt ];

  dontConfigure = true;
  dontBuild = true;
  doCheck = true;

  # patch makefile and shebangs so checks can run
  patchPhase = ''
    substituteInPlace Makefile --replace-fail '/bin:/usr/bin' '$${HOST_PATH}'
    patchShebangs src/
    patchShebangs approve
  '';

  checkPhase = ''
    make check
  '';

  installPhase = ''
    mkdir -p $out/bin/ $out/libexec
    cp src/* $out/libexec

    makeWrapper $out/libexec/adr $out/bin/adr --prefix PATH : ${
      lib.makeBinPath [
        coreutils
        findutils
        gawk
        getopt
        gnugrep
        gnused
      ]
    }
    installShellCompletion --bash autocomplete/adr
  '';

  passthru = {
    tests.default = runCommand "adr-tools-test" { } ''
      set -euo pipefail
      export PATH=$PATH:${
        lib.makeBinPath [
          adr-tools
          gnugrep
        ]
      }

      mkdir $out
      cd $out

      adr init
      test -e doc/adr/0001-record-architecture-decisions.md

      EDITOR= adr new blah
      test -e doc/adr/0002-blah.md

      adr generate toc | grep 0002-blah.md
      adr list | grep 0002-blah.md

      adr link 2 Amends 1 "TESTED AMEND"
      grep 'TESTED AMEND' doc/adr/0001-record-architecture-decisions.md | grep 0002-blah.md
    '';

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

  meta = {
    description = "Command-line tools for working with Architecture Decision Records";
    homepage = "https://github.com/npryce/adr-tools";
    license = lib.licenses.gpl3Plus;
    maintainers = with lib.maintainers; [ adamcstephens ];
    mainProgram = "adr";
    platforms = lib.platforms.all;
  };
})