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

clarify possible instances of zeebe rollback #4064

Merged
merged 2 commits into from
Jul 30, 2024

Conversation

christinaausley
Copy link
Contributor

Description

Closes https://github.com/camunda/developer-experience/issues/345.

Clarifying unique instances of rollback.

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/).

@christinaausley christinaausley added component:zeebe Issues related with Zeebe project component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed labels Jul 25, 2024
@christinaausley christinaausley self-assigned this Jul 25, 2024
@@ -163,6 +163,10 @@ If the error is caused by `Cannot upgrade to or from a pre-release version`, Zee
This is not permitted because pre-release versions such as alpha releases are considered unstable and do not guarantee compatibility with any other version.
If you attempted to update from a normal version to a pre-release version, you can roll back to the previous normal version.

:::note
While in most instances version rollbacks are not supported, in this particular use case a version rollback is possible.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
While in most instances version rollbacks are not supported, in this particular use case a version rollback is possible.
While in most instances version rollbacks are not supported, in this particular use case a version rollback of Zeebe is possible because the "new" version never became active, thanks to the safety check.

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure the extra explanation adds a lot here. We don't otherwise talk about what the safety checks or doing, and can possibly introduce new points of confusion re: "new" vs "old" instead of clarifying. If we really think our developers need this info, I'd suggest something like:

..a version rollback of Zeebe is possible, as the included safety checks prevented the pre-release version from becoming active.

Copy link
Member

Choose a reason for hiding this comment

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

I'd keep the addition of "Zeebe" then because rollback of the other applications might not be possible.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated in latest commit -- let me know what you think.

@@ -163,6 +163,10 @@ If the error is caused by `Cannot upgrade to or from a pre-release version`, Zee
This is not permitted because pre-release versions such as alpha releases are considered unstable and do not guarantee compatibility with any other version.
If you attempted to update from a normal version to a pre-release version, you can roll back to the previous normal version.

:::note
While in most instances version rollbacks are not supported, in this particular use case a version rollback is possible.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure the extra explanation adds a lot here. We don't otherwise talk about what the safety checks or doing, and can possibly introduce new points of confusion re: "new" vs "old" instead of clarifying. If we really think our developers need this info, I'd suggest something like:

..a version rollback of Zeebe is possible, as the included safety checks prevented the pre-release version from becoming active.

Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

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

👍 This looks clear to me!

@christinaausley christinaausley merged commit 7dedf4e into main Jul 30, 2024
9 checks passed
@christinaausley christinaausley deleted the clarify-zeebe-rollback branch July 30, 2024 16:52
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 component:zeebe Issues related with Zeebe project
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants