Add new section in README on how to publish and test a snapshot release #43
Conversation
WalkthroughThe update adds a new section in the README titled "How to publish a snapshot for local development & testing?". This section outlines a step-by-step process for publishing a snapshot version of the library for local testing. The guide details modifications to the Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant BG as Build.gradle
participant MV as MavenLocal
participant Gradle as Gradle CLI
participant App as App Build.gradle
participant Test as Local Testing
Dev->>BG: Update libVersion, versionCode, publication version
Dev->>BG: Replace Maven repository with mavenLocal()
Dev->>Gradle: Execute publish release command
Gradle->>MV: Publish snapshot version
Dev->>App: Add mavenLocal() to repositories & implement snapshot version
Dev->>Test: Test snapshot locally
Possibly related PRs
Suggested reviewers
🪧 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 (3)
README.md (3)
42-42: Improve URL Formatting for Markdownlint ComplianceThe first step contains a bare URL which may trigger markdown lint warnings (MD034). Consider formatting it as a proper markdown link to improve readability and ensure compliance. For example:
-1. Change `libVersion`, `versionCode` and publication `version` in https://github.com/elimu-ai/common-utils/blob/main/utils/build.gradle +1. Change `libVersion`, `versionCode` and publication `version` in [build.gradle](https://github.com/elimu-ai/common-utils/blob/main/utils/build.gradle)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
42-42: Bare URL used
null(MD034, no-bare-urls)
45-45: Fix Typographical ErrorThere is a minor typo in step 4. The word "repositsories" should be corrected to "repositories" to avoid confusion.
-4. In app side: Add `mavenLocal()` to `repositsories` block in `build.gradle` script +4. In app side: Add `mavenLocal()` to `repositories` block in `build.gradle` script
46-46: Clarify Snapshot Version PlaceholderIn step 5, the placeholder
$snapshot_versionis used. It might be helpful to add a brief note or example (for example,1.0.1-SNAPSHOT) to clarify that developers should replace the placeholder with the actual snapshot version.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
42-42: Bare URL used
null
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: build (windows-latest, 17)
- GitHub Check: build (windows-latest, 21)
🔇 Additional comments (1)
README.md (1)
40-48: Great New Snapshot Publishing Section!The new section is well-organized and provides clear, step-by-step instructions for publishing and testing a snapshot release. This level of clarity is especially valuable as it supports both experienced and new contributors—and aligns with elimu.ai's mission to build innovative learning software that empowers out-of-school children to teach themselves basic reading📖, writing✍🏽 and math🔢 within 6 months.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
42-42: Bare URL used
null(MD034, no-bare-urls)
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
README.md (1)
45-45: Step 4 – Configure App-side Repository Settings.
This step instructs developers to addmavenLocal()to therepositoriesblock in the app'sbuild.gradlescript. Note that a similar recommendation was previously provided by jo-elimu. If this repeats earlier guidance, ensure that documentation remains consistent.
🧹 Nitpick comments (2)
README.md (2)
42-42: Step 1 – Modify Build Script Parameters.
The instruction "ChangelibVersion,versionCodeand publicationversionin https://github.com/elimu-ai/common-utils/blob/main/utils/build.gradle" is clear. However, consider formatting the URL as a markdown link (e.g.,[build.gradle](https://github.com/elimu-ai/common-utils/blob/main/utils/build.gradle)) to adhere to markdownlint guidelines (MD034: no-bare-urls) and improve readability.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
42-42: Bare URL used
null(MD034, no-bare-urls)
46-46: Step 5 – Implement Snapshot Version Dependency.
Clarify what the placeholder$snapshot_versionshould be replaced with. Providing an example or linking to further documentation would enhance developer understanding and reduce potential confusion when updating the dependency.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
42-42: Bare URL used
null
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: build (windows-latest, 21)
- GitHub Check: build (windows-latest, 17)
🔇 Additional comments (4)
README.md (4)
40-41: Introduction of Snapshot Publishing Section is clear and informative.
The new section "How to publish a snapshot for local development & testing?" provides a straightforward guide that will help developers quickly understand the process. This aligns nicely with elimu.ai's mission to build innovative learning software that empowers out-of-school children to teach themselves basic reading📖, writing✍🏽, and math🔢 within 6 months.
43-43: Step 2 – Update Repository Configuration.
The direction to replace the existing Maven repository withmavenLocal()under thepublishing -> repositoriesblock is precise and practical for local snapshot testing.
44-44: Step 3 – Execute Gradle Publish Command.
The command./gradlew clean utils:publishReleasePublicationToMavenLocalis correctly provided and clearly indicates the necessary action for publishing the snapshot release.
47-48: Step 6 – Confirm Testing Readiness.
The final step "You're now ready to test the snapshot!" effectively concludes the guide on a positive note. It reassures developers that after following the instructions, the snapshot is ready for testing.
Co-authored-by: Jo G. <1451036+jo-elimu@users.noreply.github.com>
@jo-elimu Thanks. I've pushed the suggested changes. |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.md (2)
42-42: Enhance Markdown Link Formatting for Gradle File ReferenceThe bare URL in step 1 can be formatted as a clickable markdown link. This change not only improves readability but also complies with markdown best practices and addresses the MD034 static analysis warning.
-1. Change the `libVersion` and `versionCode` in https://github.com/elimu-ai/common-utils/blob/main/utils/build.gradle +1. Change the `libVersion` and `versionCode` in [utils/build.gradle](https://github.com/elimu-ai/common-utils/blob/main/utils/build.gradle)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
42-42: Bare URL used
null(MD034, no-bare-urls)
40-48: Clear and Detailed Snapshot Publishing InstructionsThe newly added section, "How to publish a snapshot for local development & testing?", provides clear, actionable steps for publishing and testing a snapshot release. The instructions are easy to follow and directly support the improved developer workflow.
A couple of suggestions:
- In step 5, consider clarifying whether
$snapshot_versionis a placeholder to be replaced with the actual snapshot version.- Ensure consistency with previously suggested changes (e.g., adding
mavenLocal()to the app’s repositories) to avoid redundancy.This documentation is essential in streamlining the release process and aligns with elimu.ai's mission to build innovative learning software that empowers out-of-school children to teach themselves basic reading📖, writing✍🏽 and math🔢 within 6 months.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
42-42: Bare URL used
null(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
42-42: Bare URL used
null
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: build (windows-latest, 21)
- GitHub Check: build (windows-latest, 17)
Add new section in README on how to publish and test a snapshot release
Summary by CodeRabbit