-
Notifications
You must be signed in to change notification settings - Fork 192
Add post_install and post_remove hooks to tool json configs #59
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| Tool Configuration Files | ||
| ======================== | ||
| Tools are configured for installation & removal using JSON files in this directory. | ||
|
|
||
| ## Parameters | ||
|
|
||
| ### `name` (string) [required] | ||
| The name of the tool in snake_case. This is used to identify the tool in the system. | ||
|
|
||
| ### `tools` (list) [required] | ||
| List of public methods that are accessible in the tool implementation. | ||
|
|
||
| ### `tools_bundled` (boolean) [optional] | ||
| Indicates that the tool file exports a `list` of tools. Specify the variable name | ||
| of the list in the `tools` field. | ||
|
|
||
| ### `cta` (string) [optional] | ||
| String to print in the terminal when the tool is installed that provides a call to action. | ||
|
|
||
| ### `env` (string) [optional] | ||
| Definitions for environment variables that will be appended to the local `.env` file. | ||
| Separate multiple environment variables with a newline character. | ||
|
|
||
| ### `packages` (list) [optional] | ||
| A list of package names to install. These are the names of the packages that will | ||
| be installed and removed by the package manager. | ||
|
|
||
| ### `post_install` (string) [optional] | ||
| Shell command that will be executed after packages have been installed and environment | ||
| variables have been set. | ||
|
|
||
| ### `post_remove` (string) [optional] | ||
| Shell command that will be executed after the tool has been removed. | ||
|
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.