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

Coerce LabelVersion to 1 for alpine labels #536

Merged
merged 3 commits into from
Sep 27, 2024

Conversation

wkrause13
Copy link
Contributor

@wkrause13 wkrause13 commented Sep 26, 2024

The way this utility is generating the json for the changelog used by our documentation portal results in duplicate entries when the release label is "alpine". This PR sets the LabelVersion value to 1 when it detects a label of "alpine". This results in a unique version for the alpine build and the non-alpine build.

I'm open to other ways of solving this, but there cannot be duplicate version keys in the resulting json.

Before:

        {
          "v1.16.11": {
            "Categories": {
              "Dependency Bumps": [
                {
                  "Note": "solo-io/gloo has been upgraded to v1.16.16."
                }
              ],
              "Fixes": [
                {
                  "Note": "Fix an issue where the wrong query param was discovered for a rest resolver. (https://github.com/solo-io/solo-projects/issues/6275)"
                },
                {
                  "Note": "Fixing MaxDepth not processed and propagated to envoy. (https://github.com/solo-io/solo-projects/issues/6372)"
                }
              ]
            },
            "ExtraNotes": null,
            "HeaderSuffix": " (Uses OSS [v1.16.16](https://github.com/solo-io/gloo/releases/tag/v1.16.16))",
            "CreatedAt": 1718805188
          }
        },
        {
          "v1.16.11": {
            "Categories": {
              "Fixes": [
                {
                  "Note": "Keep Alpine branch alive for some 1.16 branches (https://github.com/solo-io/gloo/issues/8849)"
                },
                {
                  "Note": "Adds the `host_rewrite_header` to the route options to allow envoy to swapped the host header with the content of given downstream or custom header. Pay attention to the potential security implications of using this option. Provided header must come from trusted source. (https://github.com/solo-io/gloo/issues/9579)",
                  "FromDependentVersion": "v1.16.16"
                },
                {
                  "Note": "Previously, header names consisting of invalid characters such as '()[]:;,\u003c=\u003e' were accepted when passed via the healthCheck or headerManipulation `requestHeadersToAdd` parameter. This resulted in envoy throwing an `invalid header name` error. Now, header names are validated according to RFC 9110, which is the same validation used by envoy. If a header name consisting of invalid characters is passed via the aforementioned parameters, it is caught and rejected in edge and does not propagate to envoy. (https://github.com/solo-io/gloo/issues/9622)",
                  "FromDependentVersion": "v1.16.16"
                }
              ]
            },
            "ExtraNotes": null,
            "HeaderSuffix": " (Uses OSS [v1.16.16](https://github.com/solo-io/gloo/releases/tag/v1.16.16))",
            "CreatedAt": 1718890534
          }
        },

After:

        {
          "v1.16.11": {
            "Categories": {
              "Dependency Bumps": [
                {
                  "Note": "solo-io/gloo has been upgraded to v1.16.16."
                }
              ],
              "Fixes": [
                {
                  "Note": "Fix an issue where the wrong query param was discovered for a rest resolver. (https://github.com/solo-io/solo-projects/issues/6275)"
                },
                {
                  "Note": "Fixing MaxDepth not processed and propagated to envoy. (https://github.com/solo-io/solo-projects/issues/6372)"
                }
              ]
            },
            "ExtraNotes": null,
            "HeaderSuffix": " (Uses OSS [v1.16.16](https://github.com/solo-io/gloo/releases/tag/v1.16.16))",
            "CreatedAt": 1718805188
          }
        },
        {
          "v1.16.11-alpine1": {
            "Categories": {
              "Fixes": [
                {
                  "Note": "Keep Alpine branch alive for some 1.16 branches (https://github.com/solo-io/gloo/issues/8849)"
                },
                {
                  "Note": "Adds the `host_rewrite_header` to the route options to allow envoy to swapped the host header with the content of given downstream or custom header. Pay attention to the potential security implications of using this option. Provided header must come from trusted source. (https://github.com/solo-io/gloo/issues/9579)",
                  "FromDependentVersion": "v1.16.16"
                },
                {
                  "Note": "Previously, header names consisting of invalid characters such as '()[]:;,\u003c=\u003e' were accepted when passed via the healthCheck or headerManipulation `requestHeadersToAdd` parameter. This resulted in envoy throwing an `invalid header name` error. Now, header names are validated according to RFC 9110, which is the same validation used by envoy. If a header name consisting of invalid characters is passed via the aforementioned parameters, it is caught and rejected in edge and does not propagate to envoy. (https://github.com/solo-io/gloo/issues/9622)",
                  "FromDependentVersion": "v1.16.16"
                }
              ]
            },
            "ExtraNotes": null,
            "HeaderSuffix": " (Uses OSS [v1.16.16](https://github.com/solo-io/gloo/releases/tag/v1.16.16))",
            "CreatedAt": 1718890534
          }
        },

BOT NOTES:
resolves #537

@solo-changelog-bot
Copy link

Issues linked to changelog:
#537

@soloio-bulldozer soloio-bulldozer bot merged commit f51fc89 into main Sep 27, 2024
4 checks passed
@soloio-bulldozer soloio-bulldozer bot deleted the fix-alpine-labeling branch September 27, 2024 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Duplicate version keys when label is set to alpine
2 participants