[MacPorts] #60333: terragrunt: problems with notes

MacPorts noreply at macports.org
Wed Apr 8 03:35:07 UTC 2020

#60333: terragrunt: problems with notes
 Reporter:  ryandesign  |      Owner:  macports@…
     Type:  defect      |     Status:  assigned
 Priority:  Normal      |  Milestone:
Component:  ports       |    Version:  2.6.2
 Keywords:              |       Port:  terragrunt
 $ 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?

Ticket URL: <https://trac.macports.org/ticket/60333>
MacPorts <https://www.macports.org/>
Ports system for macOS

More information about the macports-tickets mailing list