Skip to content

Commit bdb19f5

Browse files
committed
CHANGELOGs: don't include unreleased changed
Prior to this commit all CHANGELOG.md files contained an `### unreleased` section list all pending changes in changie fragments. The idea at the time was to make it easy to understand what changes would be present in an upcoming release. In practice these sections were never referred to as most developers would rely on `git log`. Worse yet they were the primary cause of backports requiring manual intervention. As the number of release branches has grown, so has the frequency of backporting and the frustration of needing to manually re-run `task generate`. This commit removes the unreleased section with the primary goal of reducing the toil of backporting commits. (cherry picked from commit 1d28958) # Conflicts: # gotohelm/CHANGELOG.md # operator/CHANGELOG.md
1 parent d360261 commit bdb19f5

File tree

5 files changed

+1
-2308
lines changed

5 files changed

+1
-2308
lines changed

Taskfile.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ tasks:
147147
- ./.changes/**/*.md
148148
- ./.changes/**/*.yaml
149149
cmds:
150-
- changie merge -u '## Unreleased' # Ensure CHANGELOG.mds are up to date.
150+
- changie merge # Ensure CHANGELOG.mds are up to date.
151151

152152
build:
153153
cmds:

charts/connectors/CHANGELOG.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
55
and is generated by [Changie](https://github.com/miniscruff/changie).
66

77

8-
## Unreleased
9-
### Changed
10-
* `values.schema.json` is now "closed" (`additionalProperties: false`)
11-
12-
Any unexpected values will result in a validation error,previously they would
13-
have been ignored.
14-
158
### [0.1.14](https://github.com/redpanda-data/helm-charts/releases/tag/connectors-0.1.14) - 2024-11-20
169
#### Added
1710
* Enabled flag that would be only used by Redpanda chart when partial values will be embedded into Redpanda values struct

charts/redpanda/CHANGELOG.md

Lines changed: 0 additions & 131 deletions
Original file line numberDiff line numberDiff line change
@@ -5,137 +5,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
55
and is generated by [Changie](https://github.com/miniscruff/changie).
66

77

8-
## Unreleased
9-
### Added
10-
* Added a chart wide `podTemplate` field which may be used to control Pod attributes chart wide.
11-
12-
This field has a lower precedence than `statefulset.podTemplate` and
13-
`post_install_job.podTemplate` but will still be merged with them.
14-
* `podTemplate`, `statefulset.podTemplate`, and `post_install_job.podTemplate` may now contain template expressions **with in string fields**
15-
16-
To compensate for some of the functionality that was lost with the removal of
17-
fields like `extraVolumes`, we've upgraded `podTemplate` fields to support
18-
templating. Rather than allowing full control over a structured value, we've
19-
reduced the scope to only string fields. This is significantly more
20-
maintainable and less error prone.
21-
22-
As an example, the below snippet will apply the release name as an annotation
23-
to all Pods created by the chart.
24-
25-
```yaml
26-
podTemplate:
27-
annotations:
28-
"keys-cannot-be-templated": '{{ .Release.Name }}' # But values can!
29-
```
30-
31-
See `values.yaml` for additional examples.
32-
* statefulset.initContainers.configurator.additionalCLIArgs is added to the helm values, to enable the init container to construct an external secret evaluator.
33-
34-
In the v2 operator, this value is defaulted from the operator's settings.
35-
### Changed
36-
* Promoted the config-watcher sidecar into a real go binary that handles user management and simplifies cluster health checks so they no longer fail when the sole issue is that other nodes in the cluster are unavailable. Additionally the new sidecar subsumes the behavior of the `statefulset.sideCars.controllers` stanza which should now be specified via their own `enabled` flags.
37-
* `clusterDomain` now defaults to `cluster.local.` (A trialing `.` has been added) and the chart no longer adds trailing `.`'s to internal domains.
38-
39-
For users not experiencing issues with trailing `.`'s this change has no
40-
effect. For users that have had issues with trailing `.`'s, it's now possible
41-
to opt-out of this behavior by explicitly setting `clusterDomain` to `cluster.local`.
42-
43-
For users that override `clusterDomain`, copied a previous releases
44-
values.yaml, or use the `--reuse-values` flag, trailing `.`'s will be tripped
45-
from domains upon updating. This behavior may be opted into by appending a
46-
`.` to `clusterDomain` prior to upgrading.
47-
* Bump AppVersion to v24.3.6 Redpanda release
48-
* Bump Redpanda operator side car container tag to `v2.3.7-24.3.6`.
49-
* `values.schema.json` is now "closed" (`additionalProperties: false`)
50-
51-
Any unexpected values will result in a validation error,previously they would
52-
have been ignored.
53-
* Update Console depedency to latest version with breaking change. Please visit Console change-log.
54-
* The name of the container running redpanda is now always set to `redpanda`.
55-
* bumped `appVersion` to [v25.1.1](https://github.com/redpanda-data/redpanda/releases/tag/v25.1.1).
56-
* `serviceAccount.create` now defaults to `true`.
57-
58-
The previous behavior resulted in using the `default` service account and
59-
extending it with all bindings generated from the chart. Such behavior is
60-
unlikely to be desired.
61-
* `rpk debug bundle --namespace $NAMESPACE` now works by default.
62-
63-
The chart now creates a set of `Roles` and `RoleBindings` that satisfy the
64-
requirements of running `rpk debug bundle` from any redpanda Pod. These
65-
permissions may be disabled by specifying `rbac.rpkDebugBundle=false`.
66-
67-
Additionally, the redpanda container now always has a Kubernetes
68-
ServiceAccount token mounted to it to ensure `rpk debug bundle` can be
69-
executed successfully.
70-
* Update Console depedency to latest version `v3.1.0`. Please visit Console change-log.
71-
### Deprecated
72-
* `.statefulset.sidecars.controllers.image` is now deprecated. It may be specified but will not be respected. Use `.statefulset.sidecars.image` instead.
73-
### Removed
74-
* Connectors sub-chart integration.
75-
76-
The connectors chart may still be deployed separately, though it is not
77-
officially support. If possible, it is recommended to migrate to redpanda
78-
connect.
79-
* Removed the deprecated fields `license_key` and `license_secret_ref` in favor
80-
of `enterprise.license` and `enterprise.licenseSecretRef`, respectively.
81-
* `statefulset.securityContext`, `statefulset.sideCars.configWatcher.securityContext` have been removed.
82-
83-
These fields previously served as both PodSecurityContext and SecurityContext
84-
across the entire chart which led to confusing semantics that couldn't be
85-
fixed without breaking backwards compatiblity.
86-
87-
The top level `podTemplate` field may be used to control
88-
PodSecurityContexts and SecurityContexts across the chart.
89-
* Fields that would be better served through `podTemplate` have been removed in favor of using `podTemplate`.
90-
91-
Removed fields:
92-
- `nodeSelector` -> `podTemplate.spec.nodeSelector`
93-
- `affinity` -> `podTemplate.spec.affinity`
94-
- `tolerations` -> `podTemplate.spec.tolerations`
95-
- `imagePullSecrets` -> `podTemplate.spec.imagePullSecrets`
96-
- `statefulset.annotations` -> `statefulset.podTemplate.annotations`
97-
- `statefulset.startupProbe` -> `statefulset.podTemplate.spec.containers[0].startupProbe`
98-
- `statefulset.livenessProbe` -> `statefulset.podTemplate.spec.containers[0].livenessProbe`
99-
- `statefulset.readinessProbe` -> `statefulset.podTemplate.spec.containers[1].readinessProbe`
100-
- `statefulset.podAffinity` -> `statefulset.podTemplate.spec.affinity.podAffinity`
101-
- `statefulset.nodeSelector` -> `statefulset.podTemplate.spec.nodeSelector`
102-
- `statefulset.priorityClassName` -> `statefulset.podTemplate.spec.priorityClassName`
103-
- `statefulset.tolerations` -> `statefulset.podTemplate.spec.tolerations`
104-
- `statefulset.topologySpreadConstraints` -> `statefulset.podTemplate.spec.topologySpreadConstraints`
105-
- `statefulset.terminationGracePeriodSeconds` -> `statefulset.podTemplate.spec.terminationGracePeriodSeconds`
106-
- `statefulset.extraVolumes` -> `statefulset.podTemplate.spec.volumes`
107-
- `statefulset.extraVolumesMounts` -> `statefulset.podTemplate.spec.containers[*].volumeMounts`
108-
- `statefulset.initContainers.*.extraVolumesMounts` -> `statefulset.podTemplate.spec.initContainers[*].volumeMounts`
109-
- `statefulset.initContainers.*.resources` -> `statefulset.podTemplate.spec.initContainers[*].resources`
110-
- `statefulset.initContainers.extraInitContainers` -> `statefulset.podTemplate.spec.initContainers`
111-
- `statefulset.sidecars.configWatcher.extraVolumeMounts` -> `statefulset.podTemplate.spec.containers[*].volumeMounts`
112-
- `statefulset.sidecars.configWatcher.resources` -> `statefulset.podTemplate.spec.containers[*].resources`
113-
- `statefulset.sidecars.configWatcher.securityContext` -> `statefulset.podTemplate.spec.containers[*].securityContext`
114-
- `statefulset.sidecars.controllers.resources` -> `statefulset.podTemplate.spec.containers[*].resources`
115-
- `statefulset.sidecars.controllers.securityContext` -> `statefulset.podTemplate.spec.containers[*].securityContext`
116-
- `statefulset.sidecars.extraVolumeMounts` -> `statefulset.podTemplate.spec.containers[*].volumeMounts`
117-
- `statefulset.sidecars.resources` -> `statefulset.podTemplate.spec.containers[*].resources`
118-
- `statefulset.sidecars.securityContext` -> `statefulset.podTemplate.spec.containers[*].securityContext`
119-
* Removed regex validation of all image tags.
120-
* The unrespected`kafkaEndpoint` listener parameter has been removed from `values.yaml`
121-
### Fixed
122-
* Reverse order of applying resources to first create ClusterRole and then ClusterRoleBinding.
123-
When Redpanda custom resource has enabled RBAC the reconciliation was blocked due
124-
ClusterRoleBinding referencing not yet created ClusterRole.
125-
126-
* Fixed an issue where not explicitly specifying a SASL auth mechanism when SASL is enabled caused Console to fail to start up.
127-
* Prevent broker nodes from restarting when solely the cluster replica amount changes
128-
* `authentication_method` is no longer set on `http_api` as redpanda itself does not support authentication on the http API.
129-
* Fixed rack awareness by mounting a service account token to the initcontainer when rack awareness is enabled.
130-
* Broken `Issuer`s and `Certificate`s are no longer needlessly generated when `tls.<cert>.issuerRef` is provided.
131-
* Fixed the security contexts' of `set-datadir-ownership` and `set-tiered-storage-cache-dir-ownership`.
132-
* The `schema_registry_client` and `pandaproxy_client` stanzas of `redpanda.yaml`
133-
now respect `listeners.kafka.tls.trustStore`, when provided.
134-
See also [helm-chart 1573 issue](https://github.com/redpanda-data/helm-charts/issues/1573).
135-
136-
* Corrected naming of `Role`s to use Fullname instead of Name, which ensures they are unique within their namespace.
137-
* Updated naming of `ClusterRole`s to include the release namespace. This ensures that they are unique per release and permits installing the chart with the same name across different namespaces.
138-
1398
## [v25.1.1-beta3](https://github.com/redpanda-data/redpanda-operator/releases/tag/charts%2Fredpanda%2Fv25.1.1-beta3) - 2025-05-06
1409
### Added
14110
* Added a chart wide `podTemplate` field which may be used to control Pod attributes chart wide.

0 commit comments

Comments
 (0)