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

Create update procedure for v1.5 #461

Closed
3 tasks
marcelstanley opened this issue Jun 24, 2024 · 2 comments
Closed
3 tasks

Create update procedure for v1.5 #461

marcelstanley opened this issue Jun 24, 2024 · 2 comments
Assignees
Labels
! High priority
Milestone

Comments

@marcelstanley
Copy link
Collaborator

marcelstanley commented Jun 24, 2024

📚 Context

Release v1.5 comes with a breaking change in the way epochs are calculated when compared to any previous v1.x release.

Such change objectively fixes #432 and, in doing so, requires that existing applications upgrade their version of the node and their instances of the History contract to have their history rewritten.

✔️ Solution

Define and test all steps required for upgrading an application from v1.4 to v1.5 if needed.

Such procedure should:

  • describe how to upgrade the version of the node
  • describe the steps to be taken by the application owner to prepare the application to have its history rewritten
  • describe how to check that the application state was kept after the upgrade is done
  • identify potential issues and propose solutions
  • list the requirements to follow the procedure (e.g.: tools, permissions etc)
  • provide examples of step success where applicable.
  • test on an environment that replicates "production" (if possible).
  • add a warning that "History contract holds claims for several applications. Changing the History affects all applications managed by that History.

Note

New history instances can be created with HistoryFactory.newHistory()

Note

In order to update an application history, is necessary to call Authority.setHistory()

📈 Subtasks

  • TBD

✅ Definition of Done

  • Migration guide created (MD document under docs folder with a link from the main README)
  • Reproduceable steps demonstrating a test application has been successfully upgraded and its state has been kept after the upgrade
@marcelstanley marcelstanley added the ! High priority label Jun 24, 2024
@marcelstanley marcelstanley added this to the 1.5.0 milestone Jun 24, 2024
@marcelstanley marcelstanley moved this to 📋 Backlog in Node Unit Jun 24, 2024
@tuler
Copy link
Member

tuler commented Jun 24, 2024

Notice that History contract holds claims for several applications.
Changing the History affects all applications managed by that History.

@marcelstanley
Copy link
Collaborator Author

Done at #507

@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Node Unit Jul 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
! High priority
Projects
Archived in project
Development

No branches or pull requests

2 participants