Opened 5 years ago
Closed 5 years ago
#60333 closed defect (fixed)
terragrunt: problems with notes
Reported by: | ryandesign (Ryan Carsten Schmidt) | Owned by: | macports@… |
---|---|---|---|
Priority: | Normal | Milestone: | |
Component: | ports | Version: | 2.6.2 |
Keywords: | Cc: | herbygillot (Herby Gillot) | |
Port: | terragrunt |
Description
$ port notes terragrunt terragrunt has the following notes: Note that terragrunt requires the terraform0.12 port to be installed. Also, it looks for terraform on the path. In order create a link, run: sudo port select --set terraform terraform0.12 Alternatively, use the TERRAGRUNT_TFPATH environment variable or the --terragrunt-tfpath command line argument to specify a specific version of terraform to use.
There are numerous problems with these notes:
- the port name is terraform-0.12 not terraform0.12
- there is no need to tell the user that it requires the terraform-0.12 port; the port already declares a dependency on it
- there is whitespace at the end of the lines (see output of
port lint
) - the notes include hard newlines in the middles of paragraphs; instead, allow MacPorts to wrap the notes to the user's terminal width by ending mid-paragraph newlines with
\
But the biggest problem is that the notes tell the user to use port select
. port select
is for the user's convenience only. A port should not require the user to use port select
in order to function correctly.
Can the terragrunt port be modified so that it finds the terraform-0.12 binary without needing to be told by the user where it is?
Change History (3)
comment:1 Changed 5 years ago by reneeotten (Renee Otten)
comment:2 Changed 5 years ago by reneeotten (Renee Otten)
okay, it actually seems very easy to make sure it uses the terraform
binary installed by MacPorts; see PR 6828. I am not sure how to use the program though, so it would be good if someone else would test...
comment:3 Changed 5 years ago by reneeotten (Renee Otten)
Resolution: | → fixed |
---|---|
Status: | assigned → closed |
Note: See
TracTickets for help on using
tickets.
sorry for the minor formatting issues with the notes, I read through the text but clearly didn't pay enough attention to the details before merging...
I asked the same question about making the port using the
terrafrom-0.12
binary in the PR. The answer appeared to be "no" (and I don't know thego
build system nor want to spend the time myself on figuring it out), so then specifying in the notes on how the end-user can get it to work is as good as one can do.