Rainnny/maven-git-versioning
1
0
Fork 0
Code Issues 1 Pull Requests 10 Actions Packages Releases Activity

Update README.md

Browse Source
This commit is contained in:
Braydon 2023-08-03 06:49:23 -04:00
parent 490bf66849
commit 42821295b1
1 changed files with 28 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -4,29 +4,31 @@ This plugin seamlessly converts standard "-SNAPSHOT" versions into a more descri
-dev-{gitDepth}-{gitHash}", allowing you to gain valuable insights into the exact commit from which each jar was built.
# Usage
```xml
<build>
<plugins>
<plugin>
<groupId>me.braydon</groupId>
<artifactId>git-versioning-maven-plugin</artifactId>
<version>1.0</version>
<executions>
<execution>
<phase>compile</phase>
<goals>
<goal>versioning</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
<pluginRepositories>
<pluginRepository>
<id>rainnny-repo-public</id>
<url>https://maven.rainnny.club/public</url>
</pluginRepository>
</pluginRepositories>
```
1. Add the plugin to your pom.xml:
```xml
<build>
<plugins>
<plugin>
<groupId>me.braydon</groupId>
<artifactId>git-versioning-maven-plugin</artifactId>
<version>1.0</version>
<executions>
<execution>
<phase>compile</phase>
<goals>
<goal>versioning</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
<pluginRepositories>
<pluginRepository>
<id>rainnny-repo-public</id>
<url>https://maven.rainnny.club/public</url>
</pluginRepository>
</pluginRepositories>
```
2. Build your project with `mvn package` (or `mvn git-versioning:versioning` if you just want to see data)