docs: update release guide #4362
Conversation
To instruct maintainers to use a minor version branch
📝 WalkthroughWalkthroughThe release guide documentation has been updated. The "Official Release" section has been renamed to "Testnet Release" with revised instructions for creating pre-releases. A new "Mainnet Release" section has been added, which specifies different tag naming and release state toggling. Instructions now clarify creating a minor version branch when missing and provide concrete examples for branch names and tag suffixes. Changes
Sequence Diagram(s)sequenceDiagram
participant Maintainer
participant Repository
%% Testnet Release Flow
note over Maintainer,Repository: Testnet Release Flow
Maintainer->>Repository: Check for minor version branch existence
alt Branch exists
Maintainer->>Repository: Use existing branch (e.g., v3.4.x)
else Branch does not exist
Maintainer->>Repository: Create minor version branch (e.g., v3.4.x)
end
Maintainer->>Repository: Tag release with -arabica or -mocha suffix (no -rc)
Maintainer->>Repository: Include Upgrade Notice in release notes
%% Mainnet Release Flow
note over Maintainer,Repository: Mainnet Release Flow
Maintainer->>Repository: Check for minor version branch existence
alt Branch exists
Maintainer->>Repository: Use existing branch (e.g., v3.4.x)
else Branch does not exist
Maintainer->>Repository: Create minor version branch (e.g., v3.4.x)
end
Maintainer->>Repository: Tag release without any suffixes
Maintainer->>Repository: Toggle off pre-release checkbox
Maintainer->>Repository: Toggle on latest release checkbox
Possibly related PRs
Suggested labels
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
docs/maintainers/release-guide.md (5)
16-16: Correct Typo in Minor Version Branch Instruction
The word “doex” appears to be a typo. It should be corrected to “does” to improve clarity.- 1. If a minor version branch doex not exist for the release you are about to create, create one. Example: `v3.4.x`. + 1. If a minor version branch does not exist for the release you are about to create, create one. Example: `v3.4.x`.
17-17: Clarify Target Branch Instruction
The instruction “Change the target branch to a minor version based. Example:v3.4.x.” is slightly unclear. Consider rephrasing it for better readability, for example: “Change the target branch to the appropriate minor version branch. For example:v3.4.x.”- 1. Change the target branch to a minor version based. Example: `v3.4.x`. + 1. Change the target branch to the appropriate minor version branch. For example: `v3.4.x`.
35-35: Add Comma for Improved Readability
A comma after “Instead” is recommended to adhere to proper punctuation style.- - The version tag should not include the `-rc` suffix. Instead append the release with `-arabica` or `-mocha` depending on the target network. + - The version tag should not include the `-rc` suffix. Instead, append the release with `-arabica` or `-mocha` depending on the target network.🧰 Tools
🪛 LanguageTool
[uncategorized] ~35-~35: A comma may be missing after the conjunctive/linking adverb ‘Instead’.
Context: ...ag should not include the-rcsuffix. Instead append the release with-arabicaor `...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
39-39: Remove Trailing Punctuation from Heading
The heading “### After creating the release:” should not have a trailing colon as per markdown style guidelines (MD026).- ### After creating the release: + ### After creating the release🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
39-39: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
43-49: Ensure Proper Markdown Formatting for Mainnet Release Section
For improved readability and to satisfy markdownlint MD032 guidelines, consider adding a blank line before and after the list items in this section. This will visually separate the list from the surrounding text.- Follow the [creating a release candidate](#creating-a-release-candidate) section with the following considerations: - - The version tag should not include the `-rc`, `-arabica`, or `-mocha` suffix. - - Toggle off the **Set as a pre-release** checkbox. - - Toggle on the **Set as the latest release** checkbox. + Follow the [creating a release candidate](#creating-a-release-candidate) section with the following considerations: + + - The version tag should not include the `-rc`, `-arabica`, or `-mocha` suffix. + - Toggle off the **Set as a pre-release** checkbox. + - Toggle on the **Set as the latest release** checkbox.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
47-47: Lists should be surrounded by blank lines
null(MD032, blanks-around-lists)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/maintainers/release-guide.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/maintainers/release-guide.md
[uncategorized] ~35-~35: A comma may be missing after the conjunctive/linking adverb ‘Instead’.
Context: ...ag should not include the -rc suffix. Instead append the release with -arabica or `...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
🪛 markdownlint-cli2 (0.17.2)
docs/maintainers/release-guide.md
39-39: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
47-47: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
⏰ Context from checks skipped due to timeout of 90000ms (8)
- GitHub Check: docker-security-build / docker-build (GHCR; ghcr.io/celestiaorg/celestia-app)
- GitHub Check: docker-txsim-build / docker-build (GHCR; ghcr.io/celestiaorg/txsim)
- GitHub Check: test / test-fuzz
- GitHub Check: test / test-race
- GitHub Check: test / test-coverage
- GitHub Check: test / test
- GitHub Check: markdown-linter / markdown-link-check
- GitHub Check: Summary
| @@ -13,7 +13,8 @@ The target audience for this guide is maintainers of this repo. In general, the | |||
|
|
|||
| 1. Navigate to <https://github.com/celestiaorg/celestia-app/releases/new>. | |||
| 1. Choose a version tag based on [Semantic Versioning](https://semver.org/). Include the `-rc` suffix followed by the next integer. RCs start at 0. | |||
| 1. Change the target branch to `v1.x` or `v2.x` based on the version you're releasing. | |||
| 1. If a minor version branch doex not exist for the release you are about to create, create one. Example: `v3.4.x`. | |||
There was a problem hiding this comment.
| 1. If a minor version branch doex not exist for the release you are about to create, create one. Example: `v3.4.x`. | |
| 1. If a minor version branch does not exist for the release you are about to create, create one. Example: `v3.4.x`. |
| - The release notes should contain an **Upgrade Notice** section with notable changes for node operators or library consumers. | ||
| - The release notes section should contain a link to <https://github.com/celestiaorg/celestia-app/blob/main/docs/release-notes/release-notes.md> where we capture breaking changes | ||
|
|
||
| After creating the release: | ||
| ### After creating the release: |
There was a problem hiding this comment.
| ### After creating the release: | |
| ### After creating the release |
To instruct maintainers to use a minor version branch.
Note: this still doesn't enforce that releases are created via minor branches but it's a first step.