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

feat: add gruntwork-io/boilerplate #19829

Merged

Conversation

ponkio-o
Copy link
Sponsor Contributor

@ponkio-o ponkio-o commented Feb 9, 2024

gruntwork-io/boilerplate: A tool for generating files and folders ("boilerplate") from a set of templates

$ aqua g -i gruntwork-io/boilerplate

How to confirm if this package works well

Reviewers aren't necessarily familiar with this package, so please describe how to confirm if this package works well.
Please confirm if this package works well yourself as much as possible.

Command and output

$ boilerplate --help
Usage: boilerplate [OPTIONS]

A tool for generating files and folders (\"boilerplate\") from a set of templates. Examples:

Generate a project in ~/output from the templates in ~/templates:

    boilerplate --template-url ~/templates --output-folder ~/output

Generate a project in ~/output from the templates in ~/templates, using variables passed in via the command line:

    boilerplate --template-url ~/templates --output-folder ~/output --var "Title=Boilerplate" --var "ShowLogo=false"

Generate a project in ~/output from the templates in ~/templates, using variables read from a file:

    boilerplate --template-url ~/templates --output-folder ~/output --var-file vars.yml

Generate a project in ~/output from the templates in this repo's include example dir, using variables read from a file:

  boilerplate --template-url
  "git@github.com:gruntwork-io/boilerplate.git//examples/for-learning-and-testing/include?ref=master"
  --output-folder ~/output --var-file vars.yml


Options:

   --template-url URL                     Generate the project from the templates in URL. This can be a local path, or a go-getter
                                          compatible URL for remote templates (e.g.,
                                          `git@github.com:gruntwork-io/boilerplate.git//examples/for-learning-and-testing/include?ref=master`).
   --output-folder FOLDER                 Create the output files and folders in FOLDER.
   --non-interactive                      Do not prompt for input variables. All variables must be set via --var and --var-file
                                          options instead. (default: false)
   --var NAME=VALUE [ --var NAME=VALUE ]  Use NAME=VALUE to set variable NAME to VALUE. May be specified more than
                                          once.
   --var-file FILE [ --var-file FILE ]    Load variable values from the YAML file FILE. May be specified more than
                                          once.
   --missing-key-action ACTION            What ACTION to take if a template looks up a variable that is not defined. Must be
                                          one of: [invalid zero error]. Default: error.
   --missing-config-action ACTION         What ACTION to take if a the template folder does not contain a boilerplate.yml
                                          file. Must be one of: [exit ignore]. Default: exit.
   --disable-hooks                        If this flag is set, no hooks will execute. (default: false)
   --disable-shell                        If this flag is set, no shell helpers will execute. They will instead return the text
                                          'replace-me'. (default: false)
   --help, -h                             show help
   --version, -v                          print the version

Reference

[gruntwork-io/boilerplate](https://github.com/gruntwork-io/boilerplate): A tool for generating files and folders ("boilerplate") from a set of templates
@suzuki-shunsuke
Copy link
Member

Thank you always!

@suzuki-shunsuke suzuki-shunsuke added the enhancement New feature or request label Feb 9, 2024
@suzuki-shunsuke suzuki-shunsuke added this to the v4.130.1 milestone Feb 9, 2024
@suzuki-shunsuke suzuki-shunsuke merged commit b6b2c85 into aquaproj:main Feb 9, 2024
16 checks passed
@ponkio-o ponkio-o deleted the feat/gruntwork-io/boilerplate branch February 9, 2024 06:49
@suzuki-shunsuke
Copy link
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants