Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pascalgn/properties-maven-extension
Maven extension to supply build properties
https://github.com/pascalgn/properties-maven-extension
continuous-integration gitflow maven-extension
Last synced: 3 months ago
JSON representation
Maven extension to supply build properties
- Host: GitHub
- URL: https://github.com/pascalgn/properties-maven-extension
- Owner: pascalgn
- License: apache-2.0
- Created: 2017-05-16T13:43:32.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-08-25T10:57:29.000Z (5 months ago)
- Last Synced: 2024-10-10T03:05:31.105Z (3 months ago)
- Topics: continuous-integration, gitflow, maven-extension
- Language: Java
- Size: 70.3 KB
- Stars: 22
- Watchers: 3
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# properties-maven-extension
[](LICENSE)
A Maven extension to introduce properties *before* the build is started.
This allows the usage of dynamic project versions like `1.2.3.${sha1}`.
## Example
For a simple example, consider the following POM file:
```xml
4.0.0
com.example
example-artifact
1.2.3.${sha1}
${git.commit.id.abbrev}
```
For a useful project version, the build would have to be invoked like `mvn clean install -Dsha1=abcd123`.
Using the Properties Maven Extension, this configuration can be set in the project directory itself,
by adding the following `.mvn/extensions.xml` file to the project:
```xml
com.github.pascalgn
properties-maven-extension
0.7.0
```
A build is now as easy as `mvn clean install` and the commit hash will be available as a property,
so that the final project version will be `1.2.3.abcd123` (depending on the current commit hash).
## Requirements
You will need at least Maven 3.5.0 for this to work. See
[the release notes](https://maven.apache.org/docs/3.5.0/release-notes.html) for more information.
You also need to run your Maven build with at least Java 11 (due to the [JGit](https://eclipse.org/jgit) dependency).
## Properties
The following properties are currently provided by the extension:
* `git.branch`, the current branch name (*master*, *feature/some-feature*, etc.)
* `git.build.datetime.simple`, build time in simple datetime format (yyyyMMdd_HHmmss)
* `git.commit.id`, the full SHA of the HEAD commit (*cbf1b9a1be984a9f61b79a05f23b19f66d533537*)
* `git.commit.id.abbrev`, the abbreviated SHA of the HEAD commit (*cbf1b9a*)
* `git.count`, the current number of commits reachable from HEAD
* `git.commit.color`, always the first six characters of the commit SHA (*cbf1b9*)
* `git.dir.git`, the absolute path of the repository (*/home/user/workspace/myproject/.git*)
* `git.dir.worktree`, the absolute path of the working tree (*/home/user/workspace/myproject*)
* `git.tag.last`, last tag from sorted tag list (*v1.2.3*)
* `git.describe.long`, combination of tag name and commit SHA (*v1.2.3-27-gcbf1b9a*)
* `git.describe.tag`, the latest tag reachable from the current branch (*v1.2.3*)
If you need more properties, feel free to create an [issue](https://github.com/pascalgn/properties-maven-extension/issues)
or a [pull request](https://github.com/pascalgn/properties-maven-extension/pulls).
## Notes
* When you use placeholders in your version, be sure to also read the [Maven CI Friendly Versions](https://maven.apache.org/maven-ci-friendly.html) guide, especially the section about the [flatten-maven-plugin](http://www.mojohaus.org/flatten-maven-plugin)
* When building in Jenkins, you might run into the issue that the
[branch name is not set due to detached HEAD](https://stackoverflow.com/questions/39297783/detached-head-w-jenkins-git-plugin-and-branch-specifier)
* The versioning scheme of this project follows [semantic versioning](http://semver.org/)
## Changelog
### Version 0.7.0
- Added new property `git.describe.long`
- Added new property `git.describe.tag` (see [#64](https://github.com/pascalgn/properties-maven-extension/issues/64))
### Version 0.6.0
- Removed unused color properties
### Version 0.5.1
- Updated maven-core dependency to fix security warnings
### Version 0.5.0
- Changed required Java version from 1.8 to 11
## Related projects
* There are already plugins providing properties, like [maven-git-commit-id-plugin](https://github.com/ktoso/maven-git-commit-id-plugin).
However, the POM structure, including versions, is built by Maven before any plugins are executed, hence this extension.
* The [maven-git-versioning-extension](https://github.com/qoomon/maven-git-versioning-extension) is very similar,
but it directly sets the project version, based on existing branches and tags, which makes it less flexible.
## License
[Apache License, Version 2.0](LICENSE)