feat: upsteams taskfiles from client, adds info on usage, adds exports/ #2
Conversation
README.md
Outdated
|
|
||
| The procedure to add it to a project is to do the following: | ||
|
|
||
| 1. Copy `exports/Taskfile.dist.yaml` to your project. |
There was a problem hiding this comment.
We can add a full command here, e.g.:
curl -sL https://raw.githubusercontent.com/masterpointio/taskit/main/exports/Taskfile.dist.yaml -o Taskfile.dist.yaml
README.md
Outdated
| The procedure to add it to a project is to do the following: | ||
|
|
||
| 1. Copy `exports/Taskfile.dist.yaml` to your project. | ||
| 2. Add the following lines to your project's `.gitignore`: |
There was a problem hiding this comment.
What do you think about adding .gitignore modifications to our task init flow?
README.md
Outdated
|
|
||
| 3. Run `task init` to initialize taskit by downloading this repo into your remote repo. Note, `git` is a requirement. | ||
| 4. Run `task --list` to list all newly available tasks from taskit. | ||
| 5. (Optional) Add a `.env.taskit` file which can include overrides for any variables in taskit. |
There was a problem hiding this comment.
Probably it's worth adding something like "After this, the setup process for taskit is all wrapped up and you're now ready to push all the configuration files to the repository."
exports/Taskfile.dist.yaml
Outdated
| - | | ||
| if [ -d .taskit ]; then | ||
| rm -rf .taskit/ | ||
| fi | ||
| mkdir -p .taskit |
There was a problem hiding this comment.
| - | | |
| if [ -d .taskit ]; then | |
| rm -rf .taskit/ | |
| fi | |
| mkdir -p .taskit | |
| - rm -rf .taskit/ | |
| - mkdir -p .taskit |
To make things more compact. rm -rf should not fail if the directory does not exist.
lib/aws/Taskfile.yaml
Outdated
| - MESSAGE | ||
| cmds: | ||
| - | | ||
|
|
lib/aws/Taskfile.yaml
Outdated
| tasks: | ||
| validate-access: | ||
| desc: Validate access to AWS for the given command | ||
| # silent: true |
There was a problem hiding this comment.
| # silent: true | |
| silent: true |
Should be silent?
lib/snaplet/Taskfile.yaml
Outdated
| includes: | ||
| aws: | ||
| taskfile: ../aws/Taskfile.yaml | ||
| aliases: [aws] |
There was a problem hiding this comment.
It's equal to a task name. Is there a benefit I'm missing?
|
@gberenice that was a great PR review, be sure to do all your PR reviews like that from now on 💯 😁. I worked to address all your feedback. Let me know if you have any additional thoughts! |
Info
exports/Taskfile.dist.yaml, which is our main file for sharing taskit aroundexports/Taskfile.dist.yaml