docs: Updated documentation to incorporate CITR & Semantic Release #17327
Conversation
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
Signed-off-by: Roger Barker <roger.barker@swirldslabs.com>
|
Targets release 0.59 |
Signed-off-by: Roger Barker <roger.barker@swirldslabs.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #17327 +/- ##
=========================================
Coverage 67.41% 67.41%
- Complexity 22092 22093 +1
=========================================
Files 2588 2588
Lines 96595 96595
Branches 10087 10087
=========================================
+ Hits 65118 65119 +1
Misses 27751 27751
+ Partials 3726 3725 -1 see 1 file with indirect coverage changes |
Coverage summary from CodacySee diff coverage on Codacy
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferencesCodacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more |
Signed-off-by: Roger Barker <roger.barker@swirldslabs.com>
Signed-off-by: Roger Barker <roger.barker@swirldslabs.com>
andrewb1269hg
requested changes
Jan 10, 2025
|
|
||
| ### 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
| The continuous integration test and release process has been being executed within Hedera-Services since Q3-2023. | |
| The continuous integration test and release (CITR) process has been being executed within Hedera-Services since Q3-2024. |
|
|
||
| ## 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
| The release process will be changing in the following areas beginning with `Release 0.59` | |
| The release process will be changing in the following areas beginning with `Release 0.59`: |
|
|
||
| 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
| The release managers will run `zxf-trigger-semantic-release`, specifying the build number, in order to create the | |
| The release managers will run the workflow `zxf-trigger-semantic-release`, specifying the build number, in order to create the |
| - 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-trigger-semantic-release` - Generate a release tag given an XTS passing build id | |
| - `zxf-trigger-semantic-release` - Generate a release tag given an XTS passing build id. |
| - `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
| latest `build-xxxxx` tag) | |
| latest `build-xxxxx` tag). |
| | **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
| Each release takes approximately one calendar quarter to complete (from planning to retrospective) | |
| Each release takes approximately one calendar quarter to complete (from planning to retrospective). |
| ### 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
| a set development cycle | |
| a set development cycle: |
docs/continuous-release.md
Outdated
|
|
||
| ### Historical Process | ||
|
|
||
| The release process within hedera-services has been using a release branching strategy that follows |
There was a problem hiding this comment.
Suggested change
| The release process within hedera-services has been using a release branching strategy that follows | |
| The release process within Hedera-Services has been using a release branching strategy that follows |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description:
Updates documentation to incorporate Semantic Release, XTS build tags, and the new release process