Align release files with our current approach #1326
Conversation
This file contains hidden or 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
njuettner
commented
May 28, 2025
|
|
||
| // marshalReleaseYAML creates a custom YAML representation of the release | ||
| // with proper field ordering and without unwanted fields like status and creationTimestamp | ||
| func marshalReleaseYAML(release v1alpha1.Release) ([]byte, error) { |
There was a problem hiding this comment.
That is the simplest way of creating a release yaml without any extra fields like status fields or creationTimestamp.
Also it is super hard to change the order for yaml when using any libraries because the ordering would look like:
- dependsOn:
- cloud-provider-aws
name: aws-ebs-csi-driver
version: 3.0.5
instead of what we have:
- name: aws-ebs-csi-driver
version: 3.0.5
dependsOn:
- cloud-provider-aws
I know looks hacky but it is the simplest way of not getting any headaches.
Using the default YAML marshaler with custom struct tags wouldn't give us the precise field ordering control needed.
njuettner
commented
May 28, 2025
| } | ||
|
|
||
| // cleanReleaseNotes removes excess blank lines from the generated release notes | ||
| func cleanReleaseNotes(notes string) string { |
There was a problem hiding this comment.
I need that for making nice formatting. I highlighted an example in the PR body
njuettner
commented
May 28, 2025
| @@ -51,6 +51,12 @@ var knownComponentParseParams = map[string]parseParams{ | |||
| start: commonStartPattern, | |||
| end: commonEndPattern, | |||
| }, | |||
| "aws-pod-identity-webhook": { | |||
There was a problem hiding this comment.
Added new components, those were missing
Gacko
approved these changes
May 28, 2025
|
Added a golden file for release CR 👍🏻 |
…detecting diffs, allowing to add new apps when using --bumpall, highlighting new apps when included
Gacko
reviewed
Jun 3, 2025
…ng os-tooling component, ...
Gacko
approved these changes
Jun 4, 2025
Comment on lines
+418
to
+426
| if componentName == "os-tooling" { | ||
| // Skip parsing os-tooling | ||
| // protected repo | ||
| return &Version{ | ||
| Name: currentVersion, | ||
| Link: changelogURLBuilder.String(), | ||
| Content: "", | ||
| }, nil | ||
| } |
There was a problem hiding this comment.
Good to know, I was already wondering why there is no changelog for capi-image-builder.
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.
Example how the format looks like:
apiVersion: release.giantswarm.io/v1alpha1 apiVersion: release.giantswarm.io/v1alpha1 kind: Release kind: Release metadata: metadata: name: aws-30.1.3 | name: aws-31.0.0 spec: spec: apps: apps: - name: aws-ebs-csi-driver - name: aws-ebs-csi-driver version: 3.0.5 version: 3.0.5 dependsOn: dependsOn: - cloud-provider-aws - cloud-provider-aws - name: aws-ebs-csi-driver-servicemonitors - name: aws-ebs-csi-driver-servicemonitors version: 0.1.0 version: 0.1.0 dependsOn: dependsOn: - prometheus-operator-crd - prometheus-operator-crd - name: aws-nth-bundle - name: aws-nth-bundle version: 1.2.1 version: 1.2.1 - name: aws-pod-identity-webhook - name: aws-pod-identity-webhook version: 1.19.1 version: 1.19.1 dependsOn: dependsOn: - cert-manager - cert-manager - name: capi-node-labeler - name: capi-node-labeler version: 1.0.2 version: 1.0.2 - name: cert-exporter - name: cert-exporter version: 2.9.5 version: 2.9.5 dependsOn: dependsOn: - kyverno-crds - kyverno-crds - name: cert-manager - name: cert-manager version: 3.9.0 | version: 3.9.1 dependsOn: dependsOn: - prometheus-operator-crd - prometheus-operator-crd - name: chart-operator-extensions - name: chart-operator-extensions version: 1.1.2 version: 1.1.2 dependsOn: dependsOn: - prometheus-operator-crd - prometheus-operator-crd - name: cilium - name: cilium version: 0.31.5 version: 0.31.5 - name: cilium-crossplane-resources - name: cilium-crossplane-resources catalog: cluster catalog: cluster version: 0.2.0 | version: 0.2.1 - name: cilium-servicemonitors - name: cilium-servicemonitors version: 0.1.3 version: 0.1.3 dependsOn: dependsOn: - prometheus-operator-crd - prometheus-operator-crd - name: cloud-provider-aws - name: cloud-provider-aws version: 1.30.8-gs1 version: 1.30.8-gs1 dependsOn: dependsOn: - vertical-pod-autoscaler-crd - vertical-pod-autoscaler-crd - name: cluster-autoscaler - name: cluster-autoscaler version: 1.30.4-gs1 | version: 1.30.4-gs2 dependsOn: dependsOn: - kyverno-crds - kyverno-crds - name: coredns - name: coredns version: 1.24.0 | version: 1.25.0 dependsOn: dependsOn: - cilium - cilium - name: coredns-extensions - name: coredns-extensions version: 0.1.2 version: 0.1.2 dependsOn: dependsOn: - vertical-pod-autoscaler-crd - vertical-pod-autoscaler-crd - name: etcd-defrag - name: etcd-defrag version: 1.0.2 | version: 1.0.4 dependsOn: dependsOn: - kyverno-crds - kyverno-crds - name: etcd-k8s-res-count-exporter - name: etcd-k8s-res-count-exporter version: 1.10.3 version: 1.10.3 dependsOn: dependsOn: - kyverno-crds - kyverno-crds - name: external-dns - name: external-dns version: 3.2.0 version: 3.2.0 dependsOn: dependsOn: - prometheus-operator-crd - prometheus-operator-crd - name: irsa-servicemonitors - name: irsa-servicemonitors version: 0.1.0 version: 0.1.0 dependsOn: dependsOn: - prometheus-operator-crd - prometheus-operator-crd - name: k8s-audit-metrics - name: k8s-audit-metrics version: 0.10.2 version: 0.10.2 dependsOn: dependsOn: - kyverno-crds - kyverno-crds - name: k8s-dns-node-cache - name: k8s-dns-node-cache version: 2.8.1 version: 2.8.1 dependsOn: dependsOn: - kyverno-crds - kyverno-crds - name: metrics-server - name: metrics-server version: 2.6.0 version: 2.6.0 dependsOn: dependsOn: - kyverno-crds - kyverno-crds - name: net-exporter - name: net-exporter version: 1.22.0 version: 1.22.0 dependsOn: dependsOn: - prometheus-operator-crd - prometheus-operator-crd - name: network-policies - name: network-policies catalog: cluster catalog: cluster version: 0.1.1 version: 0.1.1 dependsOn: dependsOn: - cilium - cilium - name: node-exporter - name: node-exporter version: 1.20.2 version: 1.20.2 dependsOn: dependsOn: - kyverno-crds - kyverno-crds - name: observability-bundle - name: observability-bundle version: 1.11.0 | version: 1.14.1 dependsOn: dependsOn: - coredns - coredns - name: observability-policies - name: observability-policies version: 0.0.1 | version: 0.0.2 dependsOn: dependsOn: - kyverno-crds - kyverno-crds - name: prometheus-blackbox-exporter - name: prometheus-blackbox-exporter version: 0.5.0 version: 0.5.0 dependsOn: dependsOn: - prometheus-operator-crd - prometheus-operator-crd - name: security-bundle - name: security-bundle catalog: giantswarm catalog: giantswarm version: 1.10.1 version: 1.10.1 dependsOn: dependsOn: - prometheus-operator-crd - prometheus-operator-crd - name: teleport-kube-agent - name: teleport-kube-agent version: 0.10.4 | version: 0.10.5 - name: vertical-pod-autoscaler - name: vertical-pod-autoscaler version: 5.4.0 | version: 5.5.0 dependsOn: dependsOn: - prometheus-operator-crd - prometheus-operator-crd - name: vertical-pod-autoscaler-crd - name: vertical-pod-autoscaler-crd version: 3.2.0 | version: 3.3.0 components: components: - name: cluster-aws - name: cluster-aws catalog: cluster catalog: cluster version: 3.2.2 version: 3.2.2 - name: flatcar - name: flatcar version: 4152.2.1 | version: 4152.2.3 - name: kubernetes - name: kubernetes version: 1.30.11 | version: v1.31.9 - name: os-tooling - name: os-tooling version: 1.24.0 | version: 1.26.1 date: "2025-05-27T09:00:00Z" | date: "2025-05-28T18:40:18Z" state: active state: activeChecklist