Skip to content
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

Change the naming convention for plugins #2720

Closed
6 tasks done
meeech opened this issue Apr 13, 2023 · 0 comments · Fixed by #2722
Closed
6 tasks done

Change the naming convention for plugins #2720

meeech opened this issue Apr 13, 2023 · 0 comments · Fixed by #2722
Labels
enhancement New feature or request

Comments

@meeech
Copy link
Contributor

meeech commented Apr 13, 2023

Summary

The current proposed naming convention is:

rollouts-my_cool_plugin-<type>-plugin

This requires using the _ - motivated by the need to parse out the plugin name from between the 2 dashes.

Jesse suggested (AR Community meeting: https://youtu.be/wjbGqrVuuDc?t=1299) to use the prefix rollouts-plugin-<type> which will then allow any string to come after and simplify any parsing and discoverability.

eg:
rollouts-plugin-trafficrouter-foo
rollouts-plugin-metric-bar

Proposal: Update docs and the few plugins already created to use this new naming scheme.

todo:

reach out to current plugin repos to let them know


Message from the maintainers:

Impacted by this bug? Give it a 👍. We prioritize the issues with the most 👍.

@meeech meeech added the enhancement New feature or request label Apr 13, 2023
meeech added a commit to meeech/argo-rollouts that referenced this issue Apr 14, 2023
* automatic linting changes - whitespace, new line at end of file

argoproj#2720
meeech added a commit to meeech/argo-rollouts that referenced this issue Apr 14, 2023
* automatic linting changes - whitespace, new line at end of file

argoproj#2720
meeech added a commit to meeech/argo-rollouts that referenced this issue Apr 14, 2023
… convention

* automatic linting changes - whitespace, new line at end of file

argoproj#2720
meeech added a commit to meeech/rollouts-plugin-metric-sample-prometheus that referenced this issue Apr 14, 2023
meeech added a commit to meeech/rollouts-plugin-metric-sample-prometheus that referenced this issue Apr 14, 2023
meeech added a commit to meeech/argo-rollouts that referenced this issue Apr 14, 2023
* update contributor plugin guide
* update analysis/plugin overview
* update trafic-management/plugin overview
* automatic linting changes - whitespace, new line at end of file

Signed-off-by: mitchell amihod <[email protected]>

argoproj#2720
zachaller pushed a commit to argoproj-labs/rollouts-plugin-metric-sample-prometheus that referenced this issue Apr 14, 2023
meeech added a commit to meeech/argo-rollouts that referenced this issue Apr 15, 2023
* update contributor plugin guide
* update analysis/plugin overview
* update trafic-management/plugin overview
* automatic linting changes - whitespace, new line at end of file

Signed-off-by: mitchell amihod <[email protected]>

argoproj#2720
zachaller pushed a commit that referenced this issue Apr 15, 2023
Update docs to reflect new plugin naming pattern

* update contributor plugin guide
* update analysis/plugin overview
* update trafic-management/plugin overview
* automatic linting changes - whitespace, new line at end of file

Signed-off-by: mitchell amihod <[email protected]>

#2720
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant