docs: release guide #3821
docs: release guide #3821
Conversation
WalkthroughWalkthroughA new file, Changes
Assessment against linked issues
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 as PR comments)
Additionally, you can add 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
Outside diff range, codebase verification and nitpick comments (1)
docs/maintainers/release-guide.md (1)
10-19: LGTM! Fix minor typo.The steps for creating a release candidate are clear and detailed. However, there is a minor typo in step 18: "pre-relase" should be "pre-release".
Apply this diff to fix the typo:
- Toggle on the **Set as a pre-relase** checkbox. + Toggle on the **Set as a pre-release** checkbox.
Co-authored-by: Callum Waters <cmwaters19@gmail.com>
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (2)
docs/maintainers/release-guide.md (2)
3-3: Add missing article for clarity.Consider adding "the" before "maintainers" for better readability.
-The target audience for this guide is maintainers of this repo. In general, the release process is as follows: +The target audience for this guide is the maintainers of this repo. In general, the release process is as follows:Tools
LanguageTool
[uncategorized] ~3-~3: You might be missing the article “the” here.
Context: ... The target audience for this guide is maintainers of this repo. In general, the release p...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
15-15: Add more information for clarity.Include the
-rcsuffix followed by the next integer. RCs start at 0.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.
Co-authored-by: Sanaz Taheri <35961250+staheri14@users.noreply.github.com>
Co-authored-by: Sanaz Taheri <35961250+staheri14@users.noreply.github.com>
Co-authored-by: Sanaz Taheri <35961250+staheri14@users.noreply.github.com>
| ## Release Candidate | ||
|
|
||
| ### Creating a release candidate | ||
|
|
||
| 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. Click **Generate release notes**. | ||
| 1. Toggle on the **Set as a pre-relase** checkbox. | ||
| 1. **Publish release**. | ||
|
|
There was a problem hiding this comment.
Consider converting steps to sub-headers.
Converting steps to sub-headers will improve readability and allow better referencing in other sections.
Apply this diff to convert steps to sub-headers:
## Release Candidate
-### Creating a release candidate
+### Step 1: Creating a release candidate
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. Click **Generate release notes**.
1. Toggle on the **Set as a pre-relase** checkbox.
1. **Publish release**.Committable suggestion was skipped due to low confidence.
| ### After creating the release candidate | ||
|
|
||
| 1. Wait until CI passes on the release and verify that prebuilt binaries were attached to the release. | ||
| 1. Create a PR to bump the celestia-app dependency in [celestia-node](https://github.com/celestiaorg/celestia-node). | ||
| 1. [Optional] Start a testnet via auto-devops that uses the release candidate. Confirm it works. | ||
| 1. [Optional] Use the release candidate to sync from genesis. Confirm it works. |
There was a problem hiding this comment.
Consider converting steps to sub-headers.
Converting steps to sub-headers will improve readability and allow better referencing in other sections.
Apply this diff to convert steps to sub-headers:
### After creating the release candidate
1. Wait until CI passes on the release and verify that prebuilt binaries were attached to the release.
1. Create a PR to bump the celestia-app dependency in [celestia-node](https://github.com/celestiaorg/celestia-node).
1. [Optional] Start a testnet via auto-devops that uses the release candidate. Confirm it works.
1. [Optional] Use the release candidate to sync from genesis. Confirm it works.Committable suggestion was skipped due to low confidence.
| ## Official Release | ||
|
|
||
| Follow the [creating a release candidate](#creating-a-release-candidate) section with the following considerations: | ||
|
|
||
| - The version tag should not include the `-rc` suffix. | ||
| - The release notes should contain an **Upgrade Notice** section with notable changes for node operators or library consumers. | ||
|
|
||
| After creating the release: | ||
|
|
||
| 1. Wait until CI passes on the release and verify that prebuilt binaries were attached to the release. | ||
| 1. Create a PR to bump the celestia-app dependency in [celestia-node](https://github.com/celestiaorg/celestia-node). |
There was a problem hiding this comment.
Consider converting steps to sub-headers and removing trailing spaces.
Converting steps to sub-headers will improve readability and allow better referencing in other sections. Also, remove trailing spaces to adhere to markdown linting rules.
Apply this diff to convert steps to sub-headers and remove trailing spaces:
## Official Release
-Follow the [creating a release candidate](#creating-a-release-candidate) section with the following considerations:
+Follow the [creating a release candidate](#creating-a-release-candidate) section with the following considerations:
- The version tag should not include the `-rc` suffix.
- The release notes should contain an **Upgrade Notice** section with notable changes for node operators or library consumers.
### After creating the release:
1. Wait until CI passes on the release and verify that prebuilt binaries were attached to the release.
1. Create a PR to bump the celestia-app dependency in [celestia-node](https://github.com/celestiaorg/celestia-node).Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Official Release | |
| Follow the [creating a release candidate](#creating-a-release-candidate) section with the following considerations: | |
| - The version tag should not include the `-rc` suffix. | |
| - The release notes should contain an **Upgrade Notice** section with notable changes for node operators or library consumers. | |
| After creating the release: | |
| 1. Wait until CI passes on the release and verify that prebuilt binaries were attached to the release. | |
| 1. Create a PR to bump the celestia-app dependency in [celestia-node](https://github.com/celestiaorg/celestia-node). | |
| ## Official Release | |
| Follow the [creating a release candidate](#creating-a-release-candidate) section with the following considerations: | |
| - The version tag should not include the `-rc` suffix. | |
| - The release notes should contain an **Upgrade Notice** section with notable changes for node operators or library consumers. | |
| ### After creating the release: | |
| 1. Wait until CI passes on the release and verify that prebuilt binaries were attached to the release. | |
| 1. Create a PR to bump the celestia-app dependency in [celestia-node](https://github.com/celestiaorg/celestia-node). |
Tools
Markdownlint
30-30: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
Closes #3521