Skip to content

Adding a template for the Argo CD version upgrade guide #25492

@reggie-k

Description

@reggie-k

Summary

Following this PR, which lists the healthchecks added to the last releases, we can have a template file for the entire upgrade doc for each minor version.

Motivation

This way we will not forget to list the added healthchecks for the next release, and provide a structured approach to listing our significant dependency upgrades.

Proposal

We can add sections as Breaking Changes, Custom Healthchecks Added, Kustomize Upgraded, Helm Upgraded, or any other frequently used headers in our upgrade instructions.

We can potentially auto-create the next minor version empty upgrade guide with headlines from the template upon the release process of a first GA release of a new minor.
For example, when we create the release 3.3.0, we can add upgrading/3.3-3.4 file which will be based on the template and just have the headlines without the content. It will then be filled manually as 3.4 is being worked on.

Metadata

Metadata

Labels

component:ciIssue related to the Makefile, Build and Release process, GitHub Actions, etc.component:docsIssues related to documentation changes and improvementsenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions