https://github.com/im-fran/sonatypecentralupload

A gradle plugin to upload artifacts to Sonatype Central
https://github.com/im-fran/sonatypecentralupload

central community-plugin gradle maven plugin sonatype sonatypecentral

Last synced: 9 days ago
JSON representation

A gradle plugin to upload artifacts to Sonatype Central

• Host: GitHub
• URL: https://github.com/im-fran/sonatypecentralupload
• Owner: Im-Fran
• License: gpl-3.0
• Created: 2024-01-26T03:19:46.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2024-03-03T13:33:25.000Z (10 months ago)
• Last Synced: 2024-05-01T18:23:04.002Z (8 months ago)
• Topics: central, community-plugin, gradle, maven, plugin, sonatype, sonatypecentral
• Language: Kotlin
• Homepage: https://plugins.gradle.org/plugin/cl.franciscosolis.sonatype-central-upload
• Size: 89.8 KB
• Stars: 8
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SonatypeCentralUpload

This is an unofficial gradle plugin to upload artifacts to [Sonatype Central Repository](https://central.sonatype.com).

# Usage

## 1. Add the plugin to your buildscript

Groovy:

```groovy

plugins {

    id 'cl.franciscosolis.sonatype-central-upload' version '1.0.3'

}

```

Kotlin:

```kts

plugins {

    id("cl.franciscosolis.sonatype-central-upload") version "1.0.3"

}

```

Here's the id for quick copy-paste (yup I also struggle with this):

```txt

cl.franciscosolis.sonatype-central-upload

```

## 2. Configure the plugin

Groovy:

```groovy

sonatypeCentralUpload {

    username = "your-username"                      // This is your Sonatype generated username

    password = "your-password"                      // This is your sonatype generated password

    

    archives = files(/*...*/)                       // This is a list of files to upload. Ideally you would point to your jar file, source and javadoc jar (required by Central)

    pom = file("path/to/pom.xml")                   // This is the pom file to upload. This is required by Central

    

    signingKey = "--BEGIN PGP PRIVATE KEY BLOCK--"  // This is your PGP private key. This is required to sign your files

    signingKeyPassphrase = "..."                    // This is your PGP private key passphrase (optional) to decrypt your private key

    publicKey = "--BEGIN PGP PUBLIC KEY BLOCK--"    // This is your PGP public key (optional). To distribute later to verify your deployments.

    publishingType = "AUTOMATIC"                    // This is the publishing strategy (optional). By default, the plugin automatically publishes the jar to Central. The possible values are: AUTOMATIC (default) or MANUAL.

}

```

Kotlin:

```kts

sonatypeCentralUpload {

    username = "your-username"                         // This is your Sonatype generated username

    password = "your-password"                         // This is your sonatype generated password

    

    archives = files(/*...*/)                          // This is a list of files to upload. Ideally you would point to your jar file, source and javadoc jar (required by Central)

    pom = file("path/to/pom.xml")                      // This is the pom file to upload. This is required by Central

    

    signingKey = "--BEGIN PGP PRIVATE KEY BLOCK--"     // This is your PGP private key. This is required to sign your files

    signingKeyPassphrase = "..."                       // This is your PGP private key passphrase (optional) to decrypt your private key

    publicKey = "--BEGIN PGP PUBLIC KEY BLOCK--"       // This is your PGP public key (optional). To distribute later to verify your deployments.

    publishingType = "AUTOMATIC"                       // This is the publishing strategy (optional). By default, the plugin automatically publishes the jar to Central. The possible values are: AUTOMATIC (default) or MANUAL.

}

```

## 3. Run the task

```bash

./gradlew sonatypeCentralUpload

```

# License

This project is licensed under the GNU GPLv3 License - see the [LICENSE](https://github.com/Im-Fran/SonatypeCentralUpload/blob/master/LICENSE) file for details