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

fix(argo-rollouts): Change type of trafficRouterPlugins and trafficRouterPlugins as list #3036

Merged
merged 9 commits into from
Nov 21, 2024

Conversation

taer
Copy link
Contributor

@taer taer commented Nov 14, 2024

The change I made here #3014 broken the examples.

This works w/ my original change:

controller:
  trafficRouterPlugins:
    - name: "argoproj-labs/gatewayAPI"
      location: "https://github.com/argoproj-labs/rollouts-plugin-trafficrouter-gatewayapi/releases/download/v0.4.0/gatewayapi-plugin-linux-arm64"
      sha256: "07e2fe515c900899c96777aac0ab490437a3d62c8adb94512ccb8b859325eb11"

But the example shows stringification is needed.

I feel having it "look like a real thing instead of a string" is more user friendly.

Checklist:

  • I have bumped the chart version according to versioning
  • I have updated the documentation according to documentation
  • I have updated the chart changelog with all the changes that come with this pull request according to changelog.
  • Any new values are backwards compatible and/or have sensible default.
  • I have signed off all my commits as required by DCO.
  • My build is green (troubleshooting builds).

The change I made here argoproj#3014 broken the examples. 

This works w/ my original change:
```
controller:
  trafficRouterPlugins:
    - name: "argoproj-labs/gatewayAPI"
      location: "https://github.com/argoproj-labs/rollouts-plugin-trafficrouter-gatewayapi/releases/download/v0.4.0/gatewayapi-plugin-linux-arm64"
      sha256: "07e2fe515c900899c96777aac0ab490437a3d62c8adb94512ccb8b859325eb11"
```

But the example shows stringification is needed.

I feel having it "look like a real thing instead of a string" is more user friendly.

Signed-off-by: Robert Macaulay <robert.macaulay@gmail.com>
@taer taer changed the title Update example values for plugins fix(argo-rollouts): Update example values for plugins Nov 14, 2024
Signed-off-by: Robert Macaulay <robert.macaulay@gmail.com>
@taer taer marked this pull request as ready for review November 14, 2024 23:20
@taer
Copy link
Contributor Author

taer commented Nov 14, 2024

My prior change was basically a breaking one.

I assumed that no one was using the values.yaml for plugins since it wasn't rendering according to the docs.

But that ship sailed, and oops.

I will renumber this build to be a non-patch change... It's just docs, but follows up to the actual breaking change for anyone who worked around the initial issue.

Signed-off-by: Robert Macaulay <robert.macaulay@gmail.com>
@taer
Copy link
Contributor Author

taer commented Nov 14, 2024

If y'all are ok w/ this, we should delete 2.37.8 since it was in fact a breaking change.. Thanks @michel-gleeson

@github-actions github-actions bot added size/S and removed size/XS labels Nov 20, 2024
@taer taer requested a review from yu-croco November 20, 2024 14:53
Signed-off-by: Robert Macaulay <robert.macaulay@gmail.com>
@yu-croco yu-croco changed the title fix(argo-rollouts): Update example values for plugins fix(argo-rollouts): Change type of trafficRouterPlugins and trafficRouterPlugins as list Nov 21, 2024
@@ -19,4 +19,4 @@ annotations:
url: https://argoproj.github.io/argo-helm/pgp_keys.asc
artifacthub.io/changes: |
- kind: fixed
description: Fixed rendering of plugins in the ConfigMap
description: Updated plugin values.yaml example and it's implementation to not need to include the stringification or the plugins block that it used to
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a result, maybe Type of trafficRouterPlugins and trafficRouterPlugins is changed from object to list is enough ?

@jmeridth jmeridth enabled auto-merge (squash) November 21, 2024 12:59
@jmeridth jmeridth merged commit ccfa065 into argoproj:main Nov 21, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants