The Purpose of this plugin is to make it easier automatically create git tags and releases
Just include the plugin into any build you’d like to use it in and assign the appropriate properties.
Gradle File
plugins {
id 'io.github.pacificengine.build.git.release' version '0.1.0'
}
project.version
The build version of the project (Example: 1.0.0
)git.tag.auto
Should a tag be pushed on every non-SNAPSHOT publish (Defaults to false
)git.tag.id
The identifier to use for the tag (Defaults to <%VERSION%>
)git.tag.message
The commit message to use for the tag (Defaults to Release <%VERSION%>
)git.executable.path
The executable to run git commands (Defaults to System Variable GIT_EXECUTABLE
otherwise git
)git.tag.repo
A list of repositories to write the tag to [;
Delimited] (Defaults to origin
)git.release.auto
Should a release be pushed on every non-SNAPSHOT publish (Defaults to false
)git.api.repo.url
The maven repo for the git project you want to push the release togit.api.url
Utilized if git.api.repo.url
is not defined. It is the base url for git maven commits (Defaults to System Variable GIT_API_URL
)git.project.name
Utilized if git.api.repo.url
is not defined. The project name of the git project you want to push the release into (Defaults to project.name.short
)``git.api.repo.key
The git key (Defaults to git.repo.key
otherwise to System Variable GIT_TOKEN
)git.release.name
The name of the release (Defaults to Release <%VERSION%>
)git.release.body
The body of the releasegit.release.draft
Should the release be marked as a draft (Defaults to false
)git.release.prerelease
Should the release be marked as a pre-release (Defaults to false
)git.release.notes
Should the release use automatically generated notes (Defaults to true
)git.release.category
The discussion categories of the releasegit.release.latest
Should the release be marked as latest (GitHub defaults this to true
)