{"id":972,"date":"2019-12-02T13:56:59","date_gmt":"2019-12-02T00:56:59","guid":{"rendered":"https:\/\/www.ronella.xyz\/?p=972"},"modified":"2023-08-18T09:12:47","modified_gmt":"2023-08-17T21:12:47","slug":"publishing-to-maven-central-with-gradle","status":"publish","type":"post","link":"https:\/\/www.ronella.xyz\/?p=972","title":{"rendered":"Publishing to Maven Central with Gradle"},"content":{"rendered":"

Pre-requisites<\/h1>\n
    \n
  1. Create an account<\/strong> to sonatype<\/a>.<\/li>\n
  2. Request for a group id<\/strong> from sonatype by using Jira to create an issue<\/a>.<\/li>\n
  3. Generate PGP keys<\/strong> to be used for signing the binaries (e.g. jar file)<\/em>. For windows, you can follow the procedure here<\/a>.<\/em><\/li>\n
  4. Wait<\/strong> for the completion of the issue you've created from item 2.<\/li>\n<\/ol>\n

    Gradle Configuration<\/h1>\n
      \n
    1. Update your gradle.properties<\/strong> to include the following properties:\n
      nexusUsername=<SONATYPE_USERNAME>\nnexusPassword=<SONATYPE_PASSWORD>\n\nsigning.keyId=<PGP_PUBLIC_KEY_ID>\nsigning.password=<PGP_PASS_PHRASE>\nsigning.secretKeyRingFile=<PGP_EXPORTED_PRIVATE_KEY>\n<\/pre>\n<\/li>\n
    2. In your build.gradle<\/strong> file,\u00a0 add the Gradle Sonatype Nexus Plugin<\/a> like the following:\n
      plugins {\n   id \"java\"\n   id \"com.bmuschko.nexus\" version \"2.3.1\" \/\/ Gradle Sonatype Nexus Plugin\n}<\/pre>\n<\/li>\n
    3. Add the following plugin configurations:\n
      modifyPom {\n    project {\n        name '<PROJECT_NAME>'\n        description '<PROJECT_DESCRIPTION>'\n        url '<PROJECT_WEBSITE>'\n        inceptionYear '<PROJECT_INCEPTION_YEAR>'\n\n        scm {\n            url '<PROJECT_SCM_ADDRESS>'\n            connection '<PROJECT_SCM_ADDRESS>'\n            developerConnection '<PROJECT_SCM_ADDRESS>'\n        }\n\n        licenses {\n            license {\n                name '<PROJECT_LICENSE_NAME>'\n                url '<PROJECT_LICENSE_ADDRESS>'\n                distribution 'repo'\n            }\n        }\n\n        developers {\n            developer {\n                id '<DEVELOPER_ID>'\n                name '<DEVELOPER_NAME>'\n                email '<DEVELOPER_EMAIL>'\n            }\n        }\n    }\n}\n\nextraArchive {\n    sources = true\n    tests = true\n    javadoc = true\n}\n\nnexus {\n    sign = true\n    repositoryUrl = '<SONATYPE_RELEASE_REPOSITORY>'\n    snapshotRepositoryUrl = '<SONATYPE_SNAPSHOT_REPOSITORY>'\n}<\/pre>\n<\/li>\n
    4. Add the Gradle Nexus Staging plugin<\/a> like the following:\n
      plugins {\n    id 'java'\n    id \"com.bmuschko.nexus\" version \"2.3.1\" \/\/ Gradle Sonatype Nexux Plugin\n    id \"io.codearte.nexus-staging\" version \"0.21.1\" \/\/ Gradle Nexus Staging Plugin\n}<\/pre>\n<\/li>\n
    5. After adding the plugin save the build.gradle file.<\/li>\n
    6. Get the staging profile ID<\/strong> by running the following command:\n
      gradlew getStagingProfile<\/pre>\n<\/li>\n
    7. Add the following plugin configuration:\n
      nexusStaging {\n    stagingProfileId = \"<STAGING_PROFILE_ID>\"\n}<\/pre>\n<\/li>\n
    8. Save the build.gradle<\/strong> file again.<\/li>\n<\/ol>\n
      Uploading to Sonatype Repository<\/h1>\n
      Run the following command:<\/p>\n
      gradlew publishToSonatype<\/pre>\n
      Publishing to Maven Central<\/h1>\n
      Run the following command:<\/p>\n
      gradlew closeAndReleaseSonatypeStagingRepository<\/pre>\n
      Errors in Publishing<\/h4>\n
      If there are any errors after running the preceding command<\/p>\n
        \n
      1. Sign in<\/strong> to the following address using your sonatype credentials<\/strong>: https:\/\/oss.sonatype.org\/<\/a><\/li>\n
      2. Click the Staging Repositories<\/strong> menu and investigate the error from there.<\/li>\n
      3. Once the errors were identified and corrected locally, upload it again to sonatype repository before publishing it again.<\/li>\n<\/ol>\n
        Do this error correction process until all the errors were corrected.<\/p><\/blockquote>\n
        Successful Publishing Validation<\/h4>\n
        After around 10 minutes<\/strong>, navigate to your registered group id from sonatype<\/strong>, starting from the following address:<\/p>\n
        https:\/\/repo.maven.apache.org\/maven2\/<\/a><\/a><\/p>\n
        After around 2 hours<\/strong>, your artifact id<\/strong> may be searchable in maven central from the following address:<\/p>\n
        https:\/\/search.maven.org\/<\/a><\/a><\/p>\n
         <\/p>\n","protected":false},"excerpt":{"rendered":"
        Pre-requisites Create an account to sonatype. Request for a group id from sonatype by using Jira to create an issue. Generate PGP keys to be used for signing the binaries (e.g. jar file). For windows, you can follow the procedure here. Wait for the completion of the issue you’ve created from item 2. Gradle Configuration […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[32,17,49],"tags":[],"_links":{"self":[{"href":"https:\/\/www.ronella.xyz\/index.php?rest_route=\/wp\/v2\/posts\/972"}],"collection":[{"href":"https:\/\/www.ronella.xyz\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.ronella.xyz\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.ronella.xyz\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.ronella.xyz\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=972"}],"version-history":[{"count":18,"href":"https:\/\/www.ronella.xyz\/index.php?rest_route=\/wp\/v2\/posts\/972\/revisions"}],"predecessor-version":[{"id":1609,"href":"https:\/\/www.ronella.xyz\/index.php?rest_route=\/wp\/v2\/posts\/972\/revisions\/1609"}],"wp:attachment":[{"href":"https:\/\/www.ronella.xyz\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=972"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.ronella.xyz\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=972"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.ronella.xyz\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=972"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}