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.

Sign up for GitHub

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

docs: update upgrading v5.1.0 #2071

Merged
merged 2 commits into from
Jul 19, 2024
Merged

docs: update upgrading v5.1.0 #2071

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d30e79d
docs: update upgrading v5.1.0
MSalopek Jul 19, 2024
5301e51
Update UPGRADING.md
MSalopek Jul 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions UPGRADING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,39 @@
# Upgrading Replicated Security

## [v5.1.x](https://github.com/cosmos/interchain-security/releases/tag/v5.1.0)

### Provider

***Note that providers using v5.0.0 cannot upgrade to v5.1.0 cleanly***

Providers using versions `v4.0.x`, `v4.1.x`, `v4.2.x`, `v4.3.x` and `v4.4.x` can upgrade to `v5.1.0`.

Upgrading from `v4.x` to `v5.1.0` will upgrade the provider `consensus version` to 7.

Upgrade code will be executed automatically during the upgrade procedure.

### Consumer

Upgrading the consumer from `v5.0.0` to `v5.1.0` will not require state migration.
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove trailing space.

There is an unnecessary trailing space at the end of this line.

- Upgrading the consumer from `v5.0.0` to `v5.1.0` will not require state migration. 
+ Upgrading the consumer from `v5.0.0` to `v5.1.0` will not require state migration.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Upgrading the consumer from `v5.0.0` to `v5.1.0` will not require state migration.
Upgrading the consumer from `v5.0.0` to `v5.1.0` will not require state migration.
Tools
Markdownlint

17-17: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


This guide provides instructions for upgrading to specific versions of Replicated Security.

## [v5.0.0](https://github.com/cosmos/interchain-security/releases/tag/v5.0.0)

### Provider
Copy link
Contributor

Choose a reason for hiding this comment

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

Avoid duplicate headings.

There are multiple headings with the same content.

- ### Provider
+ ### Provider (v5.0.0)
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### Provider
### Provider (v5.0.0)
Tools
Markdownlint

23-23: null
Multiple headings with the same content

(MD024, no-duplicate-heading)


***Note that providers should not be using this release***

v5.0.0 was a **consumer only release**.

### Consumer
Copy link
Contributor

Choose a reason for hiding this comment

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

Avoid duplicate headings.

There are multiple headings with the same content.

- ### Consumer
+ ### Consumer (v5.0.0)
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### Consumer
### Consumer (v5.0.0)
Tools
Markdownlint

29-29: null
Multiple headings with the same content

(MD024, no-duplicate-heading)


Upgrading the consumer from `v4.x` to `v5.0.0` will require state migrations.
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove trailing space.

There is an unnecessary trailing space at the end of this line.

- Upgrading the consumer from `v4.x` to `v5.0.0` will require state migrations. 
+ Upgrading the consumer from `v4.x` to `v5.0.0` will require state migrations.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Upgrading the consumer from `v4.x` to `v5.0.0` will require state migrations.
Upgrading the consumer from `v4.x` to `v5.0.0` will require state migrations.
Tools
Markdownlint

31-31: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


Consumer versions `v4.0.x`, `v4.1.x`, `v4.2.x`, `v4.3.x` and `v4.4.x` can cleanly be upgraded to `v5.0.0`.

Upgrade code will be executed automatically during the upgrade procedure.

## [v4.4.x](https://github.com/cosmos/interchain-security/releases/tag/v4.4.0)

### Provider
Expand Down
Loading