docs: Updated documentation to incorporate CITR & Semantic Release #17327
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,85 @@ | ||||||
| # Continuous Release Process | ||||||
|
|
||||||
| ## Background | ||||||
|
|
||||||
| The Release Process within Hedera-Services will be changing beginning with Release 0.59. This will be the first step in | ||||||
| migrating to a fully automated release process with CITR. | ||||||
|
|
||||||
| ### Historical Process | ||||||
|
|
||||||
| The release process within hedera-services has been using a release branching strategy that follows | ||||||
| a set development cycle | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| | Stage | Duration | | ||||||
| |-------------------------------------|----------| | ||||||
| | Planning | 12d | | ||||||
| | Development | 33d | | ||||||
| | **milestone** Create release branch | 0d | | ||||||
| | Bugs & Fix | 12d | | ||||||
| | **milestone** Deploy to preview net | 12d | | ||||||
| | **milestone** Create alpha tag | 0d | | ||||||
| | **milestone** Deploy to test net | 1d | | ||||||
| | Perform migration testing | 22d | | ||||||
| | **milestone** Deploy to main net | 7d | | ||||||
| | Release Retrospective | 1d | | ||||||
|
|
||||||
| Each release takes approximately one calendar quarter to complete (from planning to retrospective) | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| ### Relevant CITR Background | ||||||
|
|
||||||
| The continuous integration test and release process has been being executed within Hedera-Services since Q3-2023. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| As part of this process there is a minimal acceptable test suite (MATS) that runs against every pull request. Further, | ||||||
| there is an extended test suite (XTS) that runs on each commit to the `default branch` in Hedera-Services (`main`). | ||||||
| After MATS and XTS complete successfully the commit is tagged with a **build** tag (`build-XXXXX`). This tag is the | ||||||
| crux of the new release process. | ||||||
|
|
||||||
| ## CITR Release Process | ||||||
|
|
||||||
| The release process will be changing in the following areas beginning with `Release 0.59` | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| | Stage | Duration | | ||||||
| |---------------------------------------------------------|----------| | ||||||
| | Planning | 12d | | ||||||
| | Development | 33d | | ||||||
| | [NEW] **milestone** Select candidate commit for release | 0d | | ||||||
| | [NEW] Run the `zxf-trigger-semantic-release` workflow | 0d | | ||||||
| | [DEL] ~~**milestone** Create release branch~~ | ~~0d~~ | | ||||||
| | [DEL] ~~Bugs & Fix~~ | ~~12d~~ | | ||||||
| | **milestone** Deploy to preview net | 12d | | ||||||
| | [DEL] ~~**milestone** Create alpha tag~~ | ~~0d~~ | | ||||||
| | **milestone** Deploy to test net | 1d | | ||||||
| | Perform migration testing | 22d | | ||||||
| | **milestone** Deploy to main net | 7d | | ||||||
| | Release Retrospective | 1d | | ||||||
|
|
||||||
| ### Selecting a build candidate | ||||||
|
|
||||||
| The XTS workflow will tag a commit with a `build-xxxxx` tag upon successful completion. | ||||||
|
|
||||||
| The release managers will pull a release candidate from this set of tags. | ||||||
|
|
||||||
| The release managers will run `zxf-trigger-semantic-release`, specifying the build number, in order to create the | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| release tagged commit (v0.59.0 or similar) | ||||||
|
|
||||||
| **Note:** The build number is actual number described in the build tag. The tag `build-00025` has a build number `25`. | ||||||
|
|
||||||
| This release tag (v0.59.0 or similar) is the tag that will be deployed to preview-net, test-net, and main-net. | ||||||
|
|
||||||
| If bugs are discovered in the build during release testing we can run `zxf-trigger-semantic-release` on a new build | ||||||
| candidate, as determined by the release managers, and select `create patch` when running the workflow. This will | ||||||
| generate a patch version release with the new build (v0.59.1 or similar) which can then run through the various | ||||||
| test/release networks. | ||||||
|
|
||||||
| ## Impacts for Developers | ||||||
|
|
||||||
| Beginning with release 0.59: | ||||||
|
|
||||||
| - The following items will be restricted: | ||||||
| - Creating release branches in `hedera-services` (like release/0.59) | ||||||
| - Creating versioned tags like (v0.59.*) | ||||||
| - The following workflows will be added: | ||||||
| - `zxf-trigger-semantic-release` - Generate a release tag given an XTS passing build id | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| - `zxf-version-roll` - Roll the version specified in `version.txt` for the current development cycle on the default | ||||||
| branch. | ||||||
| - Release management will need to choose a build candidate from a list of associated builds (recommendation will be the | ||||||
| latest `build-xxxxx` tag) | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.