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

Update the recommended version upgrade path #4359

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

conceptualshark
Copy link
Contributor

Description

Specify that prior to 8.4, the Helm chart upgrade path is to the latest patch of the next minor version.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@@ -9,7 +9,7 @@ import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

:::note
When upgrading to a new version of the Camunda 8 Helm charts, we recommend updating to the **latest patch** release of the **next major version**.
When upgrading to a new version of the Camunda 8 Helm charts, we recommend updating to the **latest patch** release of the next **major** version of the chart.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@conceptualshark What do you think about giving an example here?
So, adding something like:

For example, If the current Helm chart version is 10.x.x and the latest next major version is 11.0.1, then it's recommended to upgrade to 11.0.1, not 11.0.0.

But that's just a suggestion and it's up to you.

@mesellings mesellings requested review from mesellings and removed request for a team September 27, 2024 09:58
Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm - only a non-blocking suggestion for rewording 👍

:::

To upgrade to a more recent version of the Camunda Helm charts, there are certain things you need to keep in mind. Review the [instructions for a specific version](#version-update-instructions) before starting the actual upgrade.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To upgrade to a more recent version of the Camunda Helm charts, there are certain things you need to keep in mind. Review the [instructions for a specific version](#version-update-instructions) before starting the actual upgrade.
Before upgrading to a more recent version of the Camunda Helm charts, you should review the [instructions for a specific version](#version-update-instructions).

Just a rewording suggestion for conciseness - wasn't sure whetehr to use "should" or "must" either?

@akeller akeller added the component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed label Sep 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

4 participants