docs: "common:utils" --> ":common-utils" #57

jo-elimu · 2025-04-27T14:55:36Z

Remove the need for changing the groupId and artifactId in the app being tested.

Changed the groupId:artifactId to match the one already used at https://jitpack.io/#ai.elimu/common-utils

Issue Number

Resolves #

Purpose

Make it easier for engineers to test -SNAPSHOT versions of this library.

Technical Details

Testing Instructions

Regression Tests

Screenshots

Summary by CodeRabbit

Documentation
- Simplified and clarified instructions for publishing and testing snapshot versions locally, reducing the number of steps and improving guidance.
Chores
- Updated the group ID and artifact ID for the utils module to new values for improved consistency.

Remove the need for changing the groupId and artifactId in the app being tested.

coderabbitai · 2025-04-27T14:57:42Z

Walkthrough

This update revises the snapshot publishing instructions in the README, simplifying the process and reducing the number of steps. It also changes the group and artifact IDs for the utils module in the build configuration, updating them to "ai.elimu" and "common-utils" respectively. No changes were made to exported or public entities beyond these configuration adjustments. These refinements support 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.

Changes

File(s)	Change Summary
README.md	Simplified and clarified the instructions for publishing and testing snapshot versions locally.
utils/build.gradle	Updated group ID from `"ai.elimu.common"` to `"ai.elimu"` and artifact ID from `"utils"` to `"common-utils"`.

Possibly related PRs

Add new section in README on how to publish and test a snapshot release #43: Simplifies and shortens the snapshot publishing instructions in the README, modifying the same section as this PR.
Add versionName/versionCode for utils's build.gradle #2: Alters versionName and versionCode settings in utils/build.gradle, related by configuration changes to the same file.
refactor: change jitpack group id to ai.elimu #50: Changes the group and artifact IDs for the utils module in utils/build.gradle, directly related to the adjustments made in this PR.

Suggested reviewers

tuancoltech

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (3)

utils/build.gradle (1)
9-11: Suggest adding project group and version properties
To keep the publication settings and project metadata in sync, consider setting the Gradle group and version at the module level. This makes the coordinates available to other plugins and tasks by default:
 def utilsGroupId = "ai.elimu"
 def utilsArtifactId = "common-utils"
+group = utilsGroupId
+version = utilsVersionName
README.md (2)
45-48: Clarify repository replacement snippet
To make step 1 crystal clear, include a diff-style example showing how to switch to mavenLocal() in your utils/build.gradle:
 publishing {
     repositories {
-        maven {
-            name = "GithubPackages"
-            url  = uri("https://maven.pkg.github.com/elimu-ai/common-utils")
-            credentials(PasswordCredentials)
-        }
+        mavenLocal()
     }
 }
46-46: Use explicit project path in Gradle command
Recommend updating step 2 to prefix the task with :utils: for clarity:
-./gradlew clean utils:publishReleasePublicationToMavenLocal
+./gradlew clean :utils:publishReleasePublicationToMavenLocal

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7d58d48 and 5fe72ad.

📒 Files selected for processing (2)

README.md (1 hunks)
utils/build.gradle (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (7)

GitHub Check: build (windows-latest, 17)
GitHub Check: build (windows-latest, 21)
GitHub Check: build (macos-latest, 17)
GitHub Check: lint
GitHub Check: build (ubuntu-latest, 21)
GitHub Check: build (macos-latest, 21)
GitHub Check: build (ubuntu-latest, 17)

🔇 Additional comments (1)

utils/build.gradle (1)

10-11: Align module coordinates for simplified publishing
In support of 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, these changes update the groupId to "ai.elimu" and the artifactId to "common-utils", matching the JitPack coordinates and eliminating extra setup steps for snapshot testing.

docs: "common:utils" --> ":common-utils"

5fe72ad

Remove the need for changing the groupId and artifactId in the app being tested.

jo-elimu requested a review from tuancoltech April 27, 2025 14:55

jo-elimu self-assigned this Apr 27, 2025

jo-elimu requested a review from a team as a code owner April 27, 2025 14:55

coderabbitai bot reviewed Apr 27, 2025

View reviewed changes

coderabbitai bot approved these changes Apr 27, 2025

View reviewed changes

tuancoltech approved these changes Apr 29, 2025

View reviewed changes

Merge branch 'main' into group-id

0f251da

jo-elimu merged commit f279667 into main Apr 29, 2025
7 checks passed

jo-elimu deleted the group-id branch April 29, 2025 05:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs: "common:utils" --> ":common-utils" #57

docs: "common:utils" --> ":common-utils" #57

Uh oh!

jo-elimu commented Apr 27, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Apr 27, 2025

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

docs: "common:utils" --> ":common-utils" #57

docs: "common:utils" --> ":common-utils" #57

Uh oh!

Conversation

jo-elimu commented Apr 27, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue Number

Purpose

Technical Details

Testing Instructions

Regression Tests

Screenshots

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Apr 27, 2025

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jo-elimu commented Apr 27, 2025 •

edited by coderabbitai bot

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)