Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chonton/git-tag-maven-plugin
create git tag from maven plugin
https://github.com/chonton/git-tag-maven-plugin
git gittag maven-plugin tag
Last synced: 3 days ago
JSON representation
create git tag from maven plugin
- Host: GitHub
- URL: https://github.com/chonton/git-tag-maven-plugin
- Owner: chonton
- License: apache-2.0
- Created: 2017-09-14T01:19:31.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T01:00:24.000Z (6 months ago)
- Last Synced: 2024-04-13T12:56:20.119Z (6 months ago)
- Topics: git, gittag, maven-plugin, tag
- Language: Java
- Size: 185 KB
- Stars: 3
- Watchers: 3
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# git-tag-maven-plugin
Tag the current head of the local git repository with a tagName and message. This annotated tag is
then pushed to a remote repository. The push can optionally be disabled.
The credentials used to authenticate to the remote repository are extracted from the
[servers](https://maven.apache.org/settings.html#Servers) section of the maven settings.xml. The
particular server credentials are selected by matching the host portion of the git url with a server
id.
| URL | ServerId |
|---------------------------------------------------------------|------------|
| git⁠@github.com:chonton/git-tag-maven-plugin.git | github.com |
| https⁠://github.com/chonton/git-tag-maven-plugin.git | github.com |
The credentials parameters must correlate with the provided url.
| URL | Required Credential Parameter(s) |
|-----------------------------------------------------------|-----------------------------------|
| git⁠@github.com:chonton/git-tag-maven-plugin.git | <username> & <password> |
| ssh git url | <privateKey> |
If an ssh git url is provided and you want to use standard ssh configuration from the ~/.ssh
directory instead of using ~/.m2/settings.xml, set the useDotSsh parameter to true.
An alternate branch can be specified. An alternate remote repository can also be specified.
Mojo details at [plugin info](https://chonton.github.io/git-tag-maven-plugin/plugin-info.html)
.
The [tag](https://chonton.github.io/git-tag-maven-plugin/tag-mojo.html) goal is by default
attached to the *deploy* phase. This will occur after any packaging type's deploy plugin goal.
The supported parameters are:
| Parameter | Required | Property | Default | Description |
|----------------|----------|-----------------|--------------------|---------------------------------------------------------------------------------------|
|skip | No |git.skip | false | Skip executing the plugin |
|tagName | Yes |git.tagName | | Tag name |
|message | No |git.message | release ${tagName} | Tag message |
|branch | No |git.branch | HEAD | Tag at head of this branch |
|remote | No |git.remote | origin | Remote repository to push tag to |
|useDotSsh | No |git.use.ssh | false | Use the contents of ~/.ssh instead of ~/.m2/settings.xml to configure ssh connections |
|skipPush | No |git.skipPush | false | Skip pushing the tag to remote |
|skipSnapshots | No |git.skipSnapshots| true | Skip creating tag for snapshots |
### Typical attached phase use:
```xml
org.honton.chas
git-tag-maven-plugin
0.0.4
tag
${version}
```
### Typical command line use:
```sh
mvn org.honton.chas:git-tag-maven-plugin:tag -Dgit.tagName=0.0.1
```