gruntwork-io / gruntwork-io/gruntwork-installer
Define an optional alias so you know which function came from which module.
- Dominant language
- Shell
- Stars
- 92
- Forks
- 55
- PR merge metrics
- No merged PRs in 30d
Description
A typical gruntwork-installer configuration in `circle.yml` looks like this:
```
...
- curl -Ls https://raw.githubusercontent.com/gruntwork-io/gruntwork-installer/master/bootstrap-gruntwork-installer.sh | bash /dev/stdin --version "v0.0.14"
- gruntwork-install --module-name "gruntwork-module-circleci-helpers" --repo "https://github.com/gruntwork-io/module-ci" --tag "v0.3.8"
- gruntwork-install --binary-name "docs-generator" --repo "https://github.com/gruntwork-io/module-ci" --tag "v0.3.8"
...
test:
override:
- run-go-tests --path test
```
The question here is where did that `run-go-tests` function come from? it'd be nice to answer this systematically. For example, imagine this revised `circle.yml`:
```
...
- gruntwork-install --alias "cci" --module-name "gruntwork-module-circleci-helpers" --repo "https://github.com/gruntwork-io/module-ci" --tag "v0.3.8"
...
test:
override:
- cci.run-go-tests --path test
```
Now it's clear exactly where this came from.
For users browsing the OS, perhaps include a `cci.help` function that explains which gruntwork-installer command was used to install this.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by tracing the gruntwork-install command and how installed module functions are exposed. Define how an optional alias qualifies functions and whether a matching help function is included; done means the revised circle.yml example can invoke cci.run-go-tests and identify its source.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- bash, shell
- Domain
- cli, devops
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100