docs(release): update release docs #5893
Conversation
Signed-off-by: ivan katliarchuk <[email protected]>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
cncf-cla: yes
Signed-off-by: ivan katliarchuk <[email protected]>
Signed-off-by: ivan katliarchuk <[email protected]>
Pull Request Test Coverage Report for Build 18427385678Details
💛 - Coveralls |
Signed-off-by: ivan katliarchuk <[email protected]>
|
/retest |
Signed-off-by: ivan katliarchuk <[email protected]>
| @@ -0,0 +1,164 @@ | |||
| # 🧭 External-DNS Version Upgrade Playbook | |||
docs/release.md
Outdated
| External-DNS follows semantic versioning principles: | ||
|
|
||
| - `0.x` → pre-stable, APIs subject to change. | ||
| - `1.x` → stable APIs and core functionality; breaking changes require a major bump. |
There was a problem hiding this comment.
I would rather say that we never have v1.0, because I'm Go it means you should never change a public exposed thing (method, func, ... does not matter).
We try to be stable enough for users such that features like source, annotations and providers don't break without migration path or we call it a bug that we want to fix as soon as possible (so fast as our time permits no eta).
Users should check each minor version release notes to the v0.x.0 release page which will explain how to migrate a breaking change without an issue.
There was a problem hiding this comment.
Ok. Updated
* master: update test certs used for pdns (kubernetes-sigs#5902) chore(controller-gen): move tools under go tools (kubernetes-sigs#5878) refactor(source/wrappers): move wrappers logic away from execute file (kubernetes-sigs#5888) chore(deps): bump the dev-dependencies group with 2 updates (kubernetes-sigs#5895) chore(deps): bump renovatebot/github-action (kubernetes-sigs#5890)
Signed-off-by: ivan katliarchuk <[email protected]>
| - Use `--dry-run` mode to preview intended changes: | ||
| - Validate logs for any unexpected record changes. | ||
| - Ensure `external-dns` correctly identifies and plans updates without actually applying them. | ||
| - **submit a feature request if `dry-run` is not supported for a specific case |
There was a problem hiding this comment.
| - **submit a feature request if `dry-run` is not supported for a specific case | |
| - **submit a feature request** if `dry-run` is not supported for a specific case |
| ```sh | ||
| aws route53 list-resource-record-sets --hosted-zone-id ZONE_ID > backup.json | ||
| ``` |
There was a problem hiding this comment.
| ```sh | |
| aws route53 list-resource-record-sets --hosted-zone-id ZONE_ID > backup.json | |
| ``` | |
| ```sh | |
| aws route53 list-resource-record-sets --hosted-zone-id ZONE_ID > backup.json | |
| ``` |
5 participants
What does it do ?
Update release docs and added best practices how to release.
Motivation
Quite often users do update minor versions, with the expectation, that breaking changes are only in major version, that we not yet planning.
More