Skip to content

build: add Maven Central publishing configuration#2

Open
syed-tp wants to merge 2 commits intomainfrom
add/mavenCentral_publish_support
Open

build: add Maven Central publishing configuration#2
syed-tp wants to merge 2 commits intomainfrom
add/mavenCentral_publish_support

Conversation

@syed-tp
Copy link
Contributor

@syed-tp syed-tp commented Jun 2, 2025

  • Configure Gradle to publish artifacts to Maven Central.
  • Set up signing, metadata, and repository credentials.
  • Add CI workflow to automate release publishing.

Summary by CodeRabbit

  • Chores
    • Introduced automated publishing workflow for Maven Central, including artifact signing and authentication.
    • Updated build configuration to streamline and standardize publishing to Maven Central, with improved metadata and automated signing.
    • Changed Android library namespace and explicitly set module version and group ID.

@coderabbitai
Copy link

coderabbitai bot commented Jun 2, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

A new GitHub Actions workflow for publishing artifacts to Maven Central was added, enabling manual publishing with secure credential handling. The Android library's build script was updated to use the Vanniktech Maven Publish plugin, standardizing the publishing process, updating the namespace, and providing detailed Maven metadata.

Changes

File(s) Change Summary
.github/workflows/publish.yml Added a GitHub Actions workflow for manual publishing to Maven Central, with secure credential and signing key management.
tpstreams-android-player/build.gradle.kts Integrated Vanniktech Maven Publish plugin, updated namespace, set group/version, and replaced manual publication config.

Poem

In the warren, code hops with delight,
A publish flow shines, clean and bright.
With secrets tucked and plugins new,
Artifacts leap to Maven’s view.
The namespace shifts, the metadata’s right—
This rabbit’s build is out of sight!
🐇✨


🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.

@codetortoiseai
Copy link

codetortoiseai bot commented Jun 2, 2025

@coderabbitai review

@coderabbitai
Copy link

coderabbitai bot commented Jun 2, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🔭 Outside diff range comments (1)
tpstreams-android-player/build.gradle.kts (1)

58-73: 🛠️ Refactor suggestion

Remove legacy afterEvaluate publication block
The old afterEvaluate { publishing { ... } } block duplicates and may conflict with the new mavenPublishing configuration. Removing it prevents accidental double publications:

-    afterEvaluate {
-        publishing {
-            publications {
-                create<MavenPublication>("release") {
-                    groupId = "com.tpstreams"
-                    artifactId = "tpstreams-player"
-                    version = "1.0.1"
-
-                    from(components["release"])
-                }
-            }
-            repositories {
-                mavenLocal()
-            }
-        }
-    }
🧹 Nitpick comments (7)
.github/workflows/publish.yml (3)

2-4: Consider expanding trigger events for automated releases
Currently, the workflow runs only on manual workflow_dispatch. If you’d like to automatically publish on new version tags (e.g., v1.2.3) or merges to main, consider adding push (with tags: or branches:) triggers.


9-11: Ensure full Git history for tag-based versioning
For reproducible Maven Central releases (especially if you switch to tag triggers), you’ll need commit history and tags. Add fetch-depth: 0 to the actions/checkout step:

- uses: actions/checkout@v4
+ uses: actions/checkout@v4
+ with:
+   fetch-depth: 0

16-17: Cache Gradle artifacts to speed up builds
Consider adding a caching step for Gradle to reduce build times on repeat runs. For example:

- name: Cache Gradle packages
  uses: actions/cache@v3
  with:
    path: |
      ~/.gradle/caches
      ~/.gradle/wrapper/
    key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
    restore-keys: |
      ${{ runner.os }}-gradle-
tpstreams-android-player/build.gradle.kts (4)

1-3: Remove unused import
AndroidSingleVariantLibrary is imported but never used. Removing unused imports keeps the build script clean and avoids warnings.


7-10: Simplify plugin declarations
The com.vanniktech.maven.publish plugin already applies maven-publish. You can remove the explicit id("maven-publish") to declutter the plugin block:

-    id("maven-publish")

89-95: Use secure license URL
Maven Central prefers https URLs. Change the license URL to:

-                url.set("http://www.apache.org/licenses/LICENSE-2.0.txt")
+                url.set("https://www.apache.org/licenses/LICENSE-2.0.txt")

84-88: Consider adding a <developers> section to the POM
Maven Central requires at least one developer entry. You can enhance your POM as follows:

pom {
    developers {
        developer {
            id.set("syed-tp")
            name.set("Syed TP")
            url.set("https://github.com/syed-tp")
        }
    }
    // existing entries...
}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7a2c50a and 859cb40.

📒 Files selected for processing (2)
  • .github/workflows/publish.yml (1 hunks)
  • tpstreams-android-player/build.gradle.kts (2 hunks)
🔇 Additional comments (1)
.github/workflows/publish.yml (1)

18-25: Validate secret names and scopes in CI settings
The environment variables for Maven Central credentials and GPG signing rely on GitHub Secrets (MAVEN_CENTRAL_USERNAME, etc.). Ensure these secrets exist in the repo or organization settings and are scoped appropriately (e.g., protected on main).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants