docs(release): better explain how to choose the new version #655
Conversation
WalkthroughThe pull request updates the Changes
Possibly related PRs
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
CodeRabbit Configuration File (
|
![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 (2)
packages/website/docs/development/release.md (2)
21-23: Enhance git command instructions with tag retrieval.The instructions are clear and helpful. Consider adding a note about getting the latest tag to make the git command more user-friendly.
- Check the new commits since the latest release to determine the type of changes included in the new version. This can be done by: - - running locally `git log --oneline <latest-release-tag>..HEAD` + - running locally: + ```bash + # Get the latest tag + LATEST_TAG=$(git describe --tags --abbrev=0) + # View commits since the latest tag + git log --oneline ${LATEST_TAG}..HEAD + ``` - going the [latest GitHub release page](https://github.com/maxGraph/maxGraph/releases/latest) and checking the commits since this release (a link is available just above the release title).🧰 Tools
🪛 LanguageTool
[grammar] ~21-~21: In this context, ‘type’ should agree in number with the noun after ‘of’.
Context: ...nce the latest release to determine the type of changes included in the new version. This can b...(TYPE_OF_PLURAL)
[uncategorized] ~23-~23: Possible missing preposition found.
Context: .....HEAD` - going the [latest GitHub release page](https://gi...(AI_HYDRA_LEO_MISSING_TO)
🪛 markdownlint-cli2 (0.17.2)
22-22: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
23-23: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
21-23: Fix grammar and formatting issues.There are a few minor issues to address:
- Grammar: "type of changes" should be "types of changes"
- Grammar: "going the" should be "going to the"
- Formatting: List items should use 2-space indentation instead of 4 spaces
- - Check the new commits since the latest release to determine the type of changes included in the new version. This can be done by: - - running locally `git log --oneline <latest-release-tag>..HEAD` - - going the [latest GitHub release page](https://github.com/maxGraph/maxGraph/releases/latest) and checking the commits since this release (a link is available just above the release title). + - Check the new commits since the latest release to determine the types of changes included in the new version. This can be done by: + - running locally `git log --oneline <latest-release-tag>..HEAD` + - going to the [latest GitHub release page](https://github.com/maxGraph/maxGraph/releases/latest) and checking the commits since this release (a link is available just above the release title).🧰 Tools
🪛 LanguageTool
[grammar] ~21-~21: In this context, ‘type’ should agree in number with the noun after ‘of’.
Context: ...nce the latest release to determine the type of changes included in the new version. This can b...(TYPE_OF_PLURAL)
[uncategorized] ~23-~23: Possible missing preposition found.
Context: .....HEAD` - going the [latest GitHub release page](https://gi...(AI_HYDRA_LEO_MISSING_TO)
🪛 markdownlint-cli2 (0.17.2)
22-22: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
23-23: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/website/docs/development/release.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
packages/website/docs/development/release.md
[grammar] ~21-~21: In this context, ‘type’ should agree in number with the noun after ‘of’.
Context: ...nce the latest release to determine the type of changes included in the new version. This can b...
(TYPE_OF_PLURAL)
[uncategorized] ~23-~23: Possible missing preposition found.
Context: .....HEAD` - going the [latest GitHub release page](https://gi...
(AI_HYDRA_LEO_MISSING_TO)
🪛 markdownlint-cli2 (0.17.2)
packages/website/docs/development/release.md
22-22: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
23-23: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
packages/website/docs/development/release.md (2)
23-26: Consider handling the case when no tags exist.The automatic tag retrieval command might fail if no tags exist in the repository. Consider adding error handling or a note about this prerequisite.
```bash + # Ensure tags exist before running this command LATEST_TAG=$(git describe --tags --abbrev=0) + if [ $? -ne 0 ]; then + echo "No tags found. Please create a tag first or use the GitHub releases page." + exit 1 + fi git log --oneline ${LATEST_TAG}..HEAD ```
22-22: Consider adjusting list indentation for consistency.The markdown linter suggests using 2-space indentation for unordered lists instead of the current 4-space indentation. While this is a minor issue, consistent indentation improves maintainability.
- Check the new commits since the latest release to determine the types of changes included in the new version. This can be done by: - - running locally `git log --oneline <latest-release-tag>..HEAD` or by automatically retrieving the latest tag: - ```bash - LATEST_TAG=$(git describe --tags --abbrev=0) - git log --oneline ${LATEST_TAG}..HEAD - ``` - - going to the [latest GitHub release page](https://github.com/maxGraph/maxGraph/releases/latest) and checking the commits since this release (a link is available just above the release title). + Check the new commits since the latest release to determine the types of changes included in the new version. This can be done by: + - running locally `git log --oneline <latest-release-tag>..HEAD` or by automatically retrieving the latest tag: + ```bash + LATEST_TAG=$(git describe --tags --abbrev=0) + git log --oneline ${LATEST_TAG}..HEAD + ``` + - going to the [latest GitHub release page](https://github.com/maxGraph/maxGraph/releases/latest) and checking the commits since this release (a link is available just above the release title).Also applies to: 27-27
🧰 Tools
🪛 LanguageTool
[typographical] ~22-~22: Two consecutive dots
Context: ...s can be done by: - running locallygit log --oneline <latest-release-tag>..HEADor by automatically retrieving the...(DOUBLE_PUNCTUATION)
🪛 markdownlint-cli2 (0.17.2)
22-22: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/website/docs/development/release.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
packages/website/docs/development/release.md
[typographical] ~22-~22: Two consecutive dots
Context: ...s can be done by: - running locally git log --oneline <latest-release-tag>..HEAD or by automatically retrieving the...
(DOUBLE_PUNCTUATION)
🪛 markdownlint-cli2 (0.17.2)
packages/website/docs/development/release.md
22-22: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
27-27: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
🔇 Additional comments (1)
packages/website/docs/development/release.md (1)
21-27: Great improvements to the documentation!The changes provide clear, actionable steps for checking commits since the last release. The addition of multiple methods (CLI and web-based) makes the documentation more user-friendly and accommodates different preferences.
🧰 Tools
🪛 LanguageTool
[typographical] ~22-~22: Two consecutive dots
Context: ...s can be done by: - running locallygit log --oneline <latest-release-tag>..HEADor by automatically retrieving the...(DOUBLE_PUNCTUATION)
🪛 markdownlint-cli2 (0.17.2)
22-22: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
27-27: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
1 participant
Summary by CodeRabbit