GNU bug report logs - #30805
[PATCH 0/3] Add terraform-docs and dependencies.

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 30805 in the body.
You can then email your comments to 30805 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Christopher Baines <mail <at> cbaines.net>
To: guix-patches <at> gnu.org
Subject: [PATCH 0/3] Add terraform-docs and dependencies.
Date: Tue, 13 Mar 2018 20:16:57 +0000

[Message part 1 (text/plain, inline)]

Christopher Baines (3):
  gnu: Add go-github-com-tj-docopt.
  gnu: Add go-github-com-hashicorp-hcl.
  gnu: Add terraform-docs.

 gnu/packages/golang.scm    | 52 +++++++++++++++++++++++++++++++++++++++++++++
 gnu/packages/terraform.scm | 53 ++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 105 insertions(+)
 create mode 100644 gnu/packages/terraform.scm

[signature.asc (application/pgp-signature, inline)]

Message #8 received at 30805 <at> debbugs.gnu.org (full text, mbox):

From: Christopher Baines <mail <at> cbaines.net>
To: 30805 <at> debbugs.gnu.org
Subject: [PATCH 3/3] gnu: Add terraform-docs.
Date: Tue, 13 Mar 2018 20:20:49 +0000

* gnu/packages/terraform.scm (terraform-docs): New variable.
---
 gnu/packages/terraform.scm | 53 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 gnu/packages/terraform.scm

diff --git a/gnu/packages/terraform.scm b/gnu/packages/terraform.scm
new file mode 100644
index 000000000..9d0bb4bcb
--- /dev/null
+++ b/gnu/packages/terraform.scm
@@ -0,0 +1,53 @@
+;;; GNU Guix --- Functional package management for GNU
+;;; Copyright © 2018 Christopher Baines <mail <at> cbaines.net>
+;;;
+;;; This file is part of GNU Guix.
+;;;
+;;; GNU Guix is free software; you can redistribute it and/or modify it
+;;; under the terms of the GNU General Public License as published by
+;;; the Free Software Foundation; either version 3 of the License, or (at
+;;; your option) any later version.
+;;;
+;;; GNU Guix is distributed in the hope that it will be useful, but
+;;; WITHOUT ANY WARRANTY; without even the implied warranty of
+;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;;; GNU General Public License for more details.
+;;;
+;;; You should have received a copy of the GNU General Public License
+;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.
+
+(define-module (gnu packages terraform)
+  #:use-module ((guix licenses) #:prefix license:)
+  #:use-module (guix packages)
+  #:use-module (guix download)
+  #:use-module (guix git-download)
+  #:use-module (guix build-system go)
+  #:use-module (gnu packages golang))
+
+(define-public terraform-docs
+  (package
+    (name "terraform-docs")
+    (version "0.3.0")
+    (source (origin
+              (method git-fetch)
+              (uri (git-reference
+                    (url "https://github.com/segmentio/terraform-docs")
+                    (commit (string-append "v" version))))
+              (file-name (git-file-name name version))
+              (sha256
+               (base32
+                "0xchpik32ab8m89s6jv671vswg8xhprfvh6s5md0zd36482d2nmm"))))
+    (build-system go-build-system)
+    (native-inputs
+     `(("go-github-com-hashicorp-hcl" ,go-github-com-hashicorp-hcl)
+       ("go-github-com-tj-docopt" ,go-github-com-tj-docopt)))
+    (arguments
+     '(#:import-path "github.com/segmentio/terraform-docs"))
+    (synopsis
+     "Generate documentation from Terraform modules")
+    (description
+     "The @code{terraform-docs} utility can generate documentation describing
+the inputs and outputs of Terraform modules.  These can be shown, or written
+to a file in JSON or Markdown formats.")
+    (home-page "https://github.com/segmentio/terraform-docs")
+    (license license:expat)))
-- 
2.16.2

Message #11 received at 30805 <at> debbugs.gnu.org (full text, mbox):

From: Christopher Baines <mail <at> cbaines.net>
To: 30805 <at> debbugs.gnu.org
Subject: [PATCH 1/3] gnu: Add go-github-com-tj-docopt.
Date: Tue, 13 Mar 2018 20:20:47 +0000

* gnu/packages/golang.scm (go-github-com-tj-docopt): New variable.
---
 gnu/packages/golang.scm | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/gnu/packages/golang.scm b/gnu/packages/golang.scm
index 20a8c538b..92e612d34 100644
--- a/gnu/packages/golang.scm
+++ b/gnu/packages/golang.scm
@@ -8,6 +8,7 @@
 ;;; Copyright © 2017 Sergei Trofimovich <slyfox <at> inbox.ru>
 ;;; Copyright © 2017 Alex Vong <alexvong1995 <at> gmail.com>
 ;;; Copyright © 2018 Tobias Geerinckx-Rice <me <at> tobias.gr>
+;;; Copyright © 2018 Christopher Baines <mail <at> cbaines.net>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -639,3 +640,27 @@ termination.")
 per-goroutine.")
     (home-page "https://github.com/jtolds/gls")
     (license license:expat)))
+
+(define-public go-github-com-tj-docopt
+  (package
+    (name "go-github-com-tj-docopt")
+    (version "1.0.0")
+    (source (origin
+              (method git-fetch)
+              (uri (git-reference
+                    (url "https://github.com/tj/docopt")
+                    (commit (string-append "v" version))))
+              (file-name (git-file-name name version))
+              (sha256
+               (base32
+                "06h8hdg1mh3s78zqlr01g4si7k0f0g6pr7fj7lnvfg446hgc7080"))))
+    (build-system go-build-system)
+    (arguments
+     '(#:import-path "github.com/tj/docopt"))
+    (synopsis "Go implementation of docopt")
+    (description
+     "This library allows the user to define a command-line interface from a
+program's help message rather than specifying it programatically with
+command-line parsers.")
+    (home-page "https://github.com/tj/docopt")
+    (license license:expat)))
-- 
2.16.2

Message #14 received at 30805 <at> debbugs.gnu.org (full text, mbox):

From: Christopher Baines <mail <at> cbaines.net>
To: 30805 <at> debbugs.gnu.org
Subject: [PATCH 2/3] gnu: Add go-github-com-hashicorp-hcl.
Date: Tue, 13 Mar 2018 20:20:48 +0000

* gnu/packages/golang.scm (go-github-com-hashicorp-hcl): New variable.
---
 gnu/packages/golang.scm | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/gnu/packages/golang.scm b/gnu/packages/golang.scm
index 92e612d34..e0ce1032f 100644
--- a/gnu/packages/golang.scm
+++ b/gnu/packages/golang.scm
@@ -664,3 +664,30 @@ program's help message rather than specifying it programatically with
 command-line parsers.")
     (home-page "https://github.com/tj/docopt")
     (license license:expat)))
+
+(define-public go-github-com-hashicorp-hcl
+  (let ((commit "23c074d0eceb2b8a5bfdbb271ab780cde70f05a8")
+        (revision "0"))
+    (package
+      (name "go-github-com-hashicorp-hcl")
+      (version (git-version "0.0.0" revision commit))
+      (source (origin
+                (method git-fetch)
+                (uri (git-reference
+                       (url "https://github.com/hashicorp/hcl")
+                       (commit commit)))
+                (file-name (git-file-name name version))
+                (sha256
+                  (base32
+                    "0db4lpqb5m130rmfy3s3gjjf4dxllypmyrzxv6ggqhkmwmc7w4mc"))))
+      (build-system go-build-system)
+      (arguments
+       '(#:tests? #f
+         #:import-path "github.com/hashicorp/hcl"))
+      (synopsis "Go implementation of HashiCorp Configuration Language")
+      (description
+       "This package contains the main implementation of the @acronym{HCL,
+HashiCorp Configuration Language}.  HCL is designed to be a language for
+expressing configuration which is easy for both humans and machines to read.")
+      (home-page "https://github.com/hashicorp/hcl")
+      (license license:mpl2.0))))
-- 
2.16.2

Message #17 received at 30805 <at> debbugs.gnu.org (full text, mbox):

From: ludo <at> gnu.org (Ludovic Courtès)
To: Christopher Baines <mail <at> cbaines.net>
Cc: 30805 <at> debbugs.gnu.org
Subject: Re: [bug#30805] [PATCH 1/3] gnu: Add go-github-com-tj-docopt.
Date: Sat, 17 Mar 2018 22:06:45 +0100

Christopher Baines <mail <at> cbaines.net> skribis:

> * gnu/packages/golang.scm (go-github-com-tj-docopt): New variable.

LGTM!

Message #20 received at 30805 <at> debbugs.gnu.org (full text, mbox):

From: ludo <at> gnu.org (Ludovic Courtès)
To: Christopher Baines <mail <at> cbaines.net>
Cc: 30805 <at> debbugs.gnu.org
Subject: Re: [bug#30805] [PATCH 2/3] gnu: Add go-github-com-hashicorp-hcl.
Date: Sat, 17 Mar 2018 22:07:07 +0100

Christopher Baines <mail <at> cbaines.net> skribis:

> * gnu/packages/golang.scm (go-github-com-hashicorp-hcl): New variable.

OK!

Message #23 received at 30805 <at> debbugs.gnu.org (full text, mbox):

From: ludo <at> gnu.org (Ludovic Courtès)
To: Christopher Baines <mail <at> cbaines.net>
Cc: 30805 <at> debbugs.gnu.org
Subject: Re: [bug#30805] [PATCH 3/3] gnu: Add terraform-docs.
Date: Sat, 17 Mar 2018 22:08:27 +0100

Christopher Baines <mail <at> cbaines.net> skribis:

> * gnu/packages/terraform.scm (terraform-docs): New variable.

[...]

> +    (synopsis
> +     "Generate documentation from Terraform modules")
> +    (description
> +     "The @code{terraform-docs} utility can generate documentation describing
> +the inputs and outputs of Terraform modules.  These can be shown, or written

Maybe s/Terraform modules/modules of the Terraform foobar/, with
appropriate “foobar”, to give a bit context.

Otherwise LGTM, thanks!

Ludo’.

Message #28 received at 30805-done <at> debbugs.gnu.org (full text, mbox):

From: Christopher Baines <mail <at> cbaines.net>
To: Ludovic Courtès <ludo <at> gnu.org>
Cc: 30805-done <at> debbugs.gnu.org
Subject: Re: [bug#30805] [PATCH 3/3] gnu: Add terraform-docs.
Date: Sat, 17 Mar 2018 23:08:58 +0000

[Message part 1 (text/plain, inline)]

Ludovic Courtès <ludo <at> gnu.org> writes:

> Christopher Baines <mail <at> cbaines.net> skribis:
>
>> * gnu/packages/terraform.scm (terraform-docs): New variable.
>
> [...]
>
>> +    (synopsis
>> +     "Generate documentation from Terraform modules")
>> +    (description
>> +     "The @code{terraform-docs} utility can generate documentation describing
>> +the inputs and outputs of Terraform modules.  These can be shown, or written
>
> Maybe s/Terraform modules/modules of the Terraform foobar/, with
> appropriate “foobar”, to give a bit context.

Sounds good. I've updated the description.

> Otherwise LGTM, thanks!

Great, I've tweaked the last patch to update local.mk and pushed these 3
patches now.

Thanks,

Chris

[signature.asc (application/pgp-signature, inline)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.