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

Jump to bottom

Documentation for upgrades and use upgrade version for enabling upgrade instead of current sequencer version #1694

Merged
merged 9 commits into from
Jul 11, 2024
Merged

Documentation for upgrades and use upgrade version for enabling upgrade instead of current sequencer version #1694

merged 9 commits into from
Jul 11, 2024

Conversation

imabdulbasit
Copy link
Contributor

@imabdulbasit imabdulbasit commented Jul 11, 2024 •
edited
Loading

This PR:

  • adds a markdown file in docs directory for upgrade documentation
  • adds comments for Upgrade struct
  • renames the view field to start_proposing_view in the struct for clarity but it is kept the same in genesis toml file
  • fix: use upgrade version instead of current version for enabling upgrade in init_node()

key files to view:

docs/upgrades.md

@imabdulbasit imabdulbasit linked an issue Jul 11, 2024 that may be closed by this pull request
Documentation for upgrades #1686
Closed
@imabdulbasit imabdulbasit changed the title Ab/upgrade docs docs for upgrade Jul 11, 2024
@imabdulbasit imabdulbasit requested a review from ss-es July 11, 2024 11:12
@imabdulbasit imabdulbasit changed the title docs for upgrade Documentation for upgrades Jul 11, 2024
@imabdulbasit imabdulbasit marked this pull request as ready for review July 11, 2024 13:47
ss-es
ss-es reviewed Jul 11, 2024
View reviewed changes
Copy link
Contributor

@ss-es ss-es left a comment

Choose a reason for hiding this comment

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

Small corrections, but otherwise looks good to me!

doc/upgrades.md Outdated Show resolved Hide resolved
doc/upgrades.md Outdated Show resolved Hide resolved
doc/upgrades.md Outdated Show resolved Hide resolved
doc/upgrades.md Outdated Show resolved Hide resolved
@imabdulbasit
Copy link
Contributor Author

Small corrections, but otherwise looks good to me!

Thank you!

@imabdulbasit imabdulbasit changed the title Documentation for upgrades Documentation for upgrades and use upgrade version for enabling upgrade instead of current sequencer version Jul 11, 2024
@imabdulbasit imabdulbasit enabled auto-merge July 11, 2024 15:10
@imabdulbasit imabdulbasit merged commit 3f38c76 into main Jul 11, 2024
13 checks passed
@imabdulbasit imabdulbasit deleted the ab/upgrade-docs branch July 11, 2024 15:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ss-es ss-es ss-es left review comments

@jbearer jbearer jbearer approved these changes

@nomaxg nomaxg Awaiting requested review from nomaxg

@philippecamacho philippecamacho Awaiting requested review from philippecamacho philippecamacho is a code owner

@ImJeremyHe ImJeremyHe Awaiting requested review from ImJeremyHe ImJeremyHe is a code owner

@sveitser sveitser Awaiting requested review from sveitser sveitser is a code owner

@tbro tbro Awaiting requested review from tbro tbro is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation for upgrades
3 participants
@imabdulbasit @jbearer @ss-es