docs: update CONTRIBUTING.md guide for releasing process #1063
Conversation
WalkthroughThe changes update the CONTRIBUTING.md file. A section describing the fat JAR build using “./gradlew java:fullJar” has been removed. The release process steps have been revised and renumbered to incorporate a new workflow. The documentation now instructs users to create a release and tag it on GitHub, followed by using a GitHub action to publish the release, replacing prior manual instructions. No modifications have been made to exported or public entities. Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant GH as GitHub
participant GA as GitHub Action
Dev->>GH: Create release & tag on GitHub
GH->>GA: Trigger GitHub action for release
GA->>GH: Publish release artifacts
Poem
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)
CONTRIBUTING.md (2)
230-233: Clarify the Changelog Generator Instructions
The updated changelog generation block now explains the command and the token generation process. Consider adding a brief example of the expected output from the command or additional tips on how to merge the generated file (delta.md) into CHANGELOG.md. Also, note that the static analysis feedback regarding adverbs ending in “ly” is minor and can be optionally addressed.🧰 Tools
🪛 LanguageTool
[uncategorized] ~230-~230: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...d to run will look something like this: `github_changelog_generator -u ably -p ably-java --since-tag v1.2.3 --output delta.md --...(HYPHENATED_LY_ADVERB_ADJECTIVE)
237-239: Review the GitHub Release Automation Steps
The new instructions for creating the release tag on GitHub and using the GitHub Action to publish the release provide a streamlined workflow compared to the previous manual process. Ensure that readers are aware of any prerequisites (e.g., necessary permissions or configuration of the GitHub Action) to avoid confusion during the release process.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[uncategorized] ~230-~230: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...d to run will look something like this: `github_changelog_generator -u ably -p ably-java --since-tag v1.2.3 --output delta.md --...
(HYPHENATED_LY_ADVERB_ADJECTIVE)
⏰ Context from checks skipped due to timeout of 90000ms (8)
- GitHub Check: check (29)
- GitHub Check: check-rest
- GitHub Check: check-realtime-okhttp
- GitHub Check: check (24)
- GitHub Check: check (21)
- GitHub Check: check-realtime
- GitHub Check: check-rest-okhttp
- GitHub Check: check (19)
Update
CONTRIBUTING.mdguide for releasing processSummary by CodeRabbit