docs: add usage docs #32
Conversation
Codecov Report
@@ Coverage Diff @@
## main #32 +/- ##
=======================================
Coverage 62.12% 62.12%
=======================================
Files 3 3
Lines 462 462
=======================================
Hits 287 287
Misses 145 145
Partials 30 30 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
| | `dry_run` | enables pretending to perform the action | `false` | `false` | | ||
| | `tag` | publish package with given alias tag | `false` | `latest` | | ||
| | `log_level` | set the log level for the plugin (valid options: `info`, `debug`, `trace`) | `true` | `info` | | ||
|
|
There was a problem hiding this comment.
Overall this change look good to me 👍
However, do you think it's worth adding the Environment Variables for the parameters?
Here are some examples for reference:
- https://github.com/go-vela/vela-docker/blob/main/DOCS.md#parameters
- https://github.com/go-vela/vela-git/blob/main/DOCS.md#parameters
- https://github.com/go-vela/vela-hugo/blob/main/DOCS.md#parameters
- https://github.com/go-vela/vela-kaniko/blob/master/DOCS.md#parameters
- https://github.com/go-vela/vela-slack/blob/main/DOCS.md#parameters
There was a problem hiding this comment.
ah yup.. will do! thanks for the catch
There was a problem hiding this comment.
fixed.. i know there are more variables we are not mentioning in docs at this time. i'm not entirely sure if that's on purpose. this was mostly transposed from internal docs.
@Cappo was there a specific reason to not include all the vars usable in the plugin in the docs? if not, i will add the remaining ones.
There was a problem hiding this comment.
we can add them later too
No description provided.