refactor: update variable configuration for consistency #48
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## master #48 +/- ##
=======================================
Coverage 45.48% 45.48%
=======================================
Files 6 6
Lines 266 266
=======================================
Hits 121 121
Misses 135 135
Partials 10 10
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The first part of this PR is modifying the environment variables and file path arguments we support for the plugin.
The idea is to introduce one consistent standard that all plugins should be able to support 👍
For environment variables, this pattern will be:
PARAMETER_<parameter_name><plugin_name>_<parameter_name>Using the
refparameter for this plugin as an example:PARAMETER_REFGIT_REFFor file path arguments, this pattern will be:
/vela/parameters/<plugin_name>/<parameter_name>/vela/secrets/<plugin_name>/<parameter_name>Using the
refparameter again for this plugin as an example:/vela/parameters/git/ref/vela/secrets/git/refThe second part of this PR is modifying the
DOCS.mdfile in the root of the repository to more accurately reflect what we have provided on our external doc site:https://go-vela.github.io/docs/plugins/pipeline/registry/git/
You'll also notice that I added the supported environment variables to those docs for all the
parameterswe support 👍