Copy of [Release n.n] Release Management Checklist
- Eric Butz
his document is intended to assist release managers in tracking the progress of required work items for a given release. Lead developers can use this checklist to understand how they might assist the release manager in achieving a release of the FIO protocol.
Release Stakeholders
Whenever checklist items are initiated or completed, communications should be posted to the interested stakeholders so they can remain in the loop with respect to the progress of a release.
Marketing – marketing/marketing discord channel (tag ash).
Account management – internal/account management (Emily)
QA – core team private on discord (Eric and Ben)
BPs – Fio main net and fio test net telegram channel, Block-producers under discussion groups.
Core team – core team private channel
Community developers – FIO developers telegram channel
Product managers – product discord channel
Please refer to the field descriptions below the checklist for more information on each item.
Task | Check Status | Tasks | Status / Deliverables |
|---|---|---|---|
Release planning |
|
|
|
Rollout planning |
| Create rollout/release plan for this effort (added actions, removed actions, table migrations, order dependent detailed instructions on how to roll out these changes successfully. include all necessary MSIGs) Refer to release script for rollout/plan for this effort Detailed instructions on how to verify that the rollout was performed successfully Review the rollout plan and verification with architecture and QA/Integration teams Refer to Master Release Plan for release details See example: [fio 3.3 fio.contracts 2.7] Release script |
|
Stories and scoping | Excluded Included | Create release management stories and subtasks for release Estimate stories |
|
LocalNet |
|
|
|
Local release rollout test | Included Excluded | Validate release script, updated by developers for each feature, detailing all addaction, createfee, and new and existing contract updates Perform local (single machine) test to validate release script See: https://developers.fioprotocol.io/docs/developers/devnet#local-testing | |
LocalNet Performance and Scaling | Included Excluded |
| |
Devnet |
|
|
|
DevNet Contract Testing | See: https://developers.fioprotocol.io/docs/developers/devnet#contract-testing-fiocontracts | What is the DevNet launch script? | |
DevNet Fork Testing | This task has two flavors:
| ||
DevNet Performance/Scalability testing | Performance and Scalability testing is a responsibility of the Developer and QA, however, it may be necessary to identify release level performance and scaling requirements | ||
QA regression testing |
| ||
Testnet |
|
|
|
fiosdk_typescript repo |
| ||
fio.test repo |
| ||
fio.devtools repo |
| ||
fio.contracts repo |
| ||
Release msigs |
| ||
Communication |
| ||
fio repo |
| ||
Testnet validation | Story to track development of fio.devtools so it automatically checks some of these: https://fioprotocol.atlassian.net/browse/BD-3056 | ||
Testnet Launch* | |||
Mainnet |
|
|
|
Mainnet prep |
| ||
fio.test repo |
| ||
fio.devtools repo |
| ||
fio.contract repo |
| ||
addaction and createfee msigs | Example:
|
| |
Contract msigs |
| ||
fio repo |
| ||
Mainnet validation |
| ||
FIO API Nodes |
| ||
SDK and Wallet Testing |
| ||
Post-deployment |
|
|
|
Mainnet validation - fio chain |
| ||
Update FIO Hosted API Nodes |
| ||
SDK |
|
|
|
Typescript SDK Release |
|
Process Description --
Each item that is to be addressed in the checklist should have a story associate with it under the release epic in jira. also there should be a release section of the wiki which contains all of the artifacts generated for a given release, and under this wiki should also be contained all the details of the release planning and execution for future reference of the community.
Devnet testing
Background – In order for a release of the FIO protocol to be rolled out on test net and main net, the release manager must first assemble the set of commands that will upgrade the current main net version to become the new release. The commands may include adding actions to FIOs list of allowed contract actions, adding/modifying the fees associated with FIO actions, creating new FIO system accounts and contracts, and updating all of the required FIO contracts with the changes for the new release. The release manager must assemble a complete list of the required commands, and execute them on a private test network, then perform validations of the resulting release. The commands, and test results must be posted on the wiki for this release.
Objective – The objective of dev net testing is to assemble the list of commands required to upgrade FIO for this release, and to complete acceptance testing of a local private FIO network upgraded using these commands.
Tactics – on dev net, build the release version of the FIO Core code and the FIO contracts, copy these off to the side. Then build the dev net using the Main net versions of the contracts and core, and spin up the dev net. Perform all of the necessary clio commands to upgrade the contracts. once this is completed run a regression test to ensure all chain operations function as expected. if there are significant changes to the FIO Core code which result in special logic and timing regarding the core and contracts rollout (this is called a forking change), then special test plans must be made and executed in accordance with the needs of the releases unique needs. If no forking logic is being released then acceptance and QA tests and some performance tests will be performed and published onto the wiki
Deliverables – The release manager will post on the wiki the commands for this release, and they will also post on the wiki the test results for the tests performed.
Contract rollout commands – The release commands for each project included in the release should be a part of the rollout plan for each project included in the release, assemble the commands for the release into one list of commands, and fill any missing gaps by cooperating with the necessary leads if commands have not yet been provided. the following actions are commonly required --
Add action – add an action to the permitted list of actions in the FIO protocol
Add Fee – add a new fee for a new action in the FIO protocol.
Add new system account – When new contracts are added to FIO an owning account must be created.
Set system account authorizations – set permissions and authorizations on new system accounts
Set privileged.
update authorizations
Set Contract – set a new contract on the FIO protocol, or update an existing contract.
Set ABI – set a new ABI on the FIO protocol, or update an existing ABI.
See also
Contract testing – After contracts have been upgraded, acceptance testing must be completed, and findings must be published to the wiki.
Fork testing – If there are changes to the protocol which require backwards compatibility considerations then forking tests must be performed, these test require code changes to be made before the fork testing to ensure that the forking logic works equivalently in the dev net environment. Results and findings must be published to the wiki upon completion.
Performance testing – Some projects have dev net level performance test considerations, when a release includes the need for performance testing then tests must be run and findings published to the wiki for the release.
QA testing – QA regression tests should be completed on each release before dev net testing, but full regression on dev net only increases our confidence in a release. findings should be published to the wiki.
NOTE – other descriptions may be added if this is seen as helpful for the document