Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bmuschko/gradle-nexus-plugin
Gradle plugin for configuring and uploading artifacts to Sonatype Nexus
https://github.com/bmuschko/gradle-nexus-plugin
gradle-plugin maven nexus publish
Last synced: about 2 months ago
JSON representation
Gradle plugin for configuring and uploading artifacts to Sonatype Nexus
- Host: GitHub
- URL: https://github.com/bmuschko/gradle-nexus-plugin
- Owner: bmuschko
- License: apache-2.0
- Archived: true
- Created: 2012-06-10T21:00:29.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2021-03-21T23:42:26.000Z (over 3 years ago)
- Last Synced: 2024-02-07T20:06:31.896Z (5 months ago)
- Topics: gradle-plugin, maven, nexus, publish
- Language: Groovy
- Size: 466 KB
- Stars: 290
- Watchers: 15
- Forks: 49
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Lists
- awesome - gradle-nexus-plugin - Gradle plugin for configuring and uploading artifacts to Sonatype Nexus (Groovy)
- awesome-gradle - gradle-nexus-plugin - Configure and upload artifacts to Sonatype Nexus. (Plugins / Releasing)
README
# Gradle Sonatype Nexus plugin [](https://github.com/bmuschko/gradle-nexus-plugin/actions?query=workflow%3A%22Build+and+Release+%5BLinux%5D%22)
This project reached end of life (EOL) status due to its incompatibility with Gradle 7.0. No more feature requests will be considered. Bug fixes will be accepted as long as they will be compatible with earlier versions of Gradle.
The plugin provides support for configuring and uploading artifacts to [Sonatype Nexus](http://www.sonatype.org/nexus/). It can
be configured to deploy to a self-hosted instance of Nexus or Sonatype OSS. The default setup is to publish
to Sonatype OSS. Currently, Java and Groovy project artifact generation is supported. In addition to the JAR and POM file
artifacts containing the JavaDocs and source files are created. Signing the artifacts is optional.
## Usage
To use the Sonatype Nexus plugin, include in your build script:
```groovy
apply plugin: 'com.bmuschko.nexus'
```
The plugin JAR needs to be defined in the classpath of your build script. It is directly available on
[Bintray](https://bintray.com/bmuschko/gradle-plugins/com.bmuschko%3Agradle-nexus-plugin).
Alternatively, you can download it from GitHub and deploy it to your local repository. The following code snippet shows an
example on how to retrieve it from Maven Central:
```groovy
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'com.bmuschko:gradle-nexus-plugin:2.3.1'
}
}
```
## Tasks
The Nexus plugin can add three tasks to your project:
* `javadocJar`: Assembles a jar archive containing the generated Javadoc API documentation of this project (added by default).
* `sourcesJar`: Assembles a jar archive containing the main sources of this project (added by default).
* `testsJar`: Assembles a jar archive containing the test sources of this project.
The output of all tasks is added to the `archives` configuration. To tell the plugin that any of these tasks should be
added to the project or removed, you will need to set a specific extension property.
Additionally, it applies the [Maven plugin](http://gradle.org/docs/current/userguide/maven_plugin.html) as well
as `signing` in order to leverage maven's `install` and `uploadArchives` tasks.
## Extension properties
The plugin defines the following extension properties in the `extraArchive` closure:
* `javadoc`: Adds Javadoc JAR task to project (defaults to true).
* `sources`: Adds sources JAR task to project (defaults to true).
* `tests`: Adds test sources JAR task to project (defaults to false).
The plugin defines the following extension properties in the `nexus` closure:
* `sign`: Specifies whether to sign the artifacts using the [signing plugin](http://gradle.org/docs/current/userguide/signing_plugin.html) (defaults to true).
* `configuration`: The custom configuration used to publish artifacts (defaults to `archives`).
* `repositoryUrl`: The stable release repository URL (defaults to `https://oss.sonatype.org/service/local/staging/deploy/maven2/`).
* `snapshotRepositoryUrl`: The snapshot repository URL (defaults to `https://oss.sonatype.org/content/repositories/snapshots/`).
## Additional configuration
### POM customization
In addition to the convention properties the automatically generated POM file can be modified. To provide the data for
the POM generation specify the information within the configuration element `modifyPom.project`.
```groovy
modifyPom {
project {
...
}
}
```
### Credentials
In your `~/.gradle/gradle.properties` you will need to set the mandatory Nexus credentials required for uploading your artifacts.
```groovy
nexusUsername = yourUsername
nexusPassword = yourPassword
```
If you don't specify one of these properties, the plugin will prompt your for their values in the console.
### Example
```groovy
modifyPom {
project {
name 'Gradle Sonatype Nexus plugin'
description 'Gradle plugin that provides tasks for configuring and uploading artifacts to Sonatype Nexus.'
url 'https://github.com/bmuschko/gradle-nexus-plugin'
inceptionYear '2012'
scm {
url 'https://github.com/bmuschko/gradle-nexus-plugin'
connection 'scm:https://[email protected]/bmuschko/gradle-nexus-plugin.git'
developerConnection 'scm:git://github.com/bmuschko/gradle-nexus-plugin.git'
}
licenses {
license {
name 'The Apache Software License, Version 2.0'
url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
distribution 'repo'
}
}
developers {
developer {
id 'bmuschko'
name 'Benjamin Muschko'
email '[email protected]'
}
}
}
}
extraArchive {
sources = false
tests = true
javadoc = false
}
nexus {
sign = true
repositoryUrl = 'http://localhost:8081/nexus/content/repositories/internal/'
snapshotRepositoryUrl = 'http://localhost:8081/nexus/content/repositories/internal-snapshots/'
}
```
## FAQ
**How do I publish my artifacts to the Central Repository aka Maven Central aka Sonatype OSS?**
By default the plugin is configured to upload your artifacts to the release and snapshot repository URLs of Sonatype OSS.
There's no additional configuration required. If you want to tweak the automatically generated POM file please you the
`modifyPom` closure. Make sure to stick to the process described in
the [Central Repository Documentation](http://central.sonatype.org/pages/producers.html).
**Is it possible to automatically publish artifacts to Maven Central without any manual steps in the Nexus GUI (e.g. from CI server)?**
It is beyond the scope of this plugin, but there is a dedicated 3rd-party plugin
[gradle-nexus-staging-plugin](https://github.com/Codearte/gradle-nexus-staging-plugin) which allows for releasing and promoting
artifacts to Maven Central directly from Gradle. It also seamlessly integrates with gradle-nexus-plugin (e.g. allows to
reuse provided credentials).