Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

While the checklists capture the ToDos for a release, the following notes address the what and how of a release.

References:

Git Branching and Release (fioprotocol.io)

...

Jira Legacy
serverSystem JIRA
serverId5f0d8161-d4cf-3d17-96b1-53b2b2b5013d
keyBD-3615

Overview/Notes

Release Management focuses on the capture (release branching) and delivery (deployment and test to *DevNet, TestNet, MainNet) of features, bugs, etc.

MainNet deliveries: most changes will be merged into the Develop branch and flow down through DevNet, and TestNet but some (Hot Fixes) may not.

*DevNet deployment/test is considered happy path deployment and testing. It may be prudent to smoketest FIP branches (to be/are merged into Develop) to verify a Develop branch.

Release Content

The Project Manager will provide details and links to Development Documents, Development Documents (Active), to be included in a release.

Release Branching

The release branch naming will looking follow the release as documented in Releases folder.

Release Readiness

Release readiness entails the process of gathering the information noted above but also the deployment and testing of FIP, Develop branches along with application of the Release script on these branches to identify any issues, gaps in functionality, prior to cutting a release branch. This could include a formal review/demo of the Feature(s) with the Project Manager and the team.

LocalNet/FIP Build, Deploy and Test Process

  1. Review the Master Release Plan at Master Release Plan and identify the current MainNet release branches. For example, the 3.3.0 Release has the following repos/branches:

    1. fio - release/3.3.x-dev

    2. fio.contracts - release/2.7.x

    3. fio.test - release/2.7.x_3.3.x

    4. fio.devtools - release/2.7.x_3.3.x

    5. fiosdk_typescript - release/1.6.x

  2. On the server, create and build a develop version of the contracts

    1. Clone the FIO Core branches and checkout each repo to the develop branch.

      1. fio - develop

      2. fio.contracts - develop

      3. fio.devtools - develop

    2. Build and install FIO

      1. cd fio/scripts

      2. Execute ./fio_build.sh

    3. Build the contracts

      1. cd fio.contracts

      2. Execute ./start.sh <FIO Version>

        1. Local Startup (1)

        2. Update/Build Contracts (2)

    4. Copy this version of the fio.contracts to fio.contracts-develop

  3. On the server, update the repos cloned above to test the functionality that will be in the release. For example to build, deploy and test the FIP-41, FIP-17a, FIP-1 release, the FIO core repos were checked out as follows:

    1. fio.contracts - release/2.7.x

    2. fio.devtools - release/2.7.x_3.3.x

  4. To test the individual FIP branches, identify those branches via the developer, the FIO github project or via the project development spec (reference Release Content above) and checkout the modified branches. For example, to test the FIP-41 updates, fio.contracts, fio.devtools were updated. Checkout the branches as follows:

    1. fio.contracts - feature/FIP-41-develop-03012022

    2. fio.devtools - feature/FIP-41-develop-03012022