Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kengotoda/gradle-semantic-release-plugin
Automated release management for Gradle project
https://github.com/kengotoda/gradle-semantic-release-plugin
gradle semantic-release semantic-release-plugin
Last synced: about 1 month ago
JSON representation
Automated release management for Gradle project
- Host: GitHub
- URL: https://github.com/kengotoda/gradle-semantic-release-plugin
- Owner: KengoTODA
- License: mit
- Created: 2019-03-18T02:11:40.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-09T19:32:06.000Z (about 1 month ago)
- Last Synced: 2024-10-11T20:20:29.784Z (about 1 month ago)
- Topics: gradle, semantic-release, semantic-release-plugin
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/gradle-semantic-release-plugin
- Size: 3.41 MB
- Stars: 36
- Watchers: 4
- Forks: 17
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# A semantic-release plugin for Gradle project
Yet another gradle-semantic-release-plugin that invokes Gradle wrapper script to release.
[](https://github.com/KengoTODA/gradle-semantic-release-plugin/actions/workflows/build.yml)
[](https://www.npmjs.com/package/gradle-semantic-release-plugin)
[](http://commitizen.github.io/cz-cli/)
[](https://github.com/semantic-release/semantic-release)
# Precondition
To apply this semantic-release plugin, you need to fulfill the following preconditions:
1. Your Gradle project should manage its version by `gradle.properties` (not by `build.gradle` nor `build.gradle.kts`).
2. Your Gradle project should have an executable Gradle wrapper script at the project root directory.
3. Your CI environment should run on Linux environment that can run `./gradlew`.
4. Your Gradle project should use [Maven Publish Plugin](https://docs.gradle.org/current/userguide/publishing_maven.html), [Legacy publishing](https://docs.gradle.org/current/userguide/artifact_management.html), [Gradle Artifactory Plugin](https://www.jfrog.com/confluence/display/RTF/Gradle+Artifactory+Plugin), [Gradle Nexus Publish Plugin](https://github.com/gradle-nexus/publish-plugin/), or [Plugin Publishing Plugin](https://docs.gradle.org/current/userguide/publishing_gradle_plugins.html) to publish artifact.
# Procedure to install
## Install semantic-release
Follow [install guide](https://semantic-release.gitbook.io/semantic-release/usage/installation) and [CI configuration guide](https://semantic-release.gitbook.io/semantic-release/usage/ci-configuration) described in the semantic-release official document.
To manage version of toolset, we recommend you to have a `package.json` in your project root directory. Manage both of `semantic-release` and its plugins as `devDependencies`.
Refer [the spotbugs-gradle-plugin project](https://github.com/spotbugs/spotbugs-gradle-plugin) as a working example.
## Configure `@semantic-release/git`
This plugin updates `gradle.properties` to bump up project version. If you want to keep the version in this file updated, configure `@semantic-release/git` to commit changes. You can configure your `package.json` like below:
```json
"release": {
"plugins": [
"gradle-semantic-release-plugin",
[
"@semantic-release/git",
{
"assets": [
"gradle.properties"
]
}
]
]
},
```
# Gradle Properties
## Publish Properties
Users can specify an API key and secret by supplying the following environment variables:
1. `GRADLE_PUBLISH_KEY=my-key`
- This will get translated to `-Pgradle.publish.key=my-key`
2. `GRADLE_PUBLISH_SECRET=my-secret`
- This will get translated to `-Pgradle.publish.secret=my-secret`
Possible usage in `build.gradle.kts`
```kotlin
publishing {
repositories {
maven {
name = "OrgRepo"
url = uri("https://maven.pkg.github.com/org/repo")
credentials {
username = project.properties["gradle.publish.key"].toString()
password = project.properties["gradle.publish.secret"].toString()
}
}
}
}
```
# FAQ
## How it's different with the [@tschulte/gradle-semantic-release-plugin](https://github.com/tschulte/gradle-semantic-release-plugin)?
That is a Gradle plugin implemented by Java. It can use Gradle's feature and ecosystem. However, it emulates `semantic-release` and cannot use other semantic-release plugin at the same time.
Our plugin is a semantic-release plugin. It can work with other plugin implemented on node.js, but it just invokes Gradle and cannot handle so complex requirements by own.
## Copyright
Copyright (c) 2019-2024 Kengo TODA