https://github.com/kumuluz/kumuluzee-version
KumuluzEE Version to expose version details of your microservices.
https://github.com/kumuluz/kumuluzee-version
jakartaee java javaee kumuluz kumuluzee microservices version versioning
Last synced: about 2 months ago
JSON representation
KumuluzEE Version to expose version details of your microservices.
- Host: GitHub
- URL: https://github.com/kumuluz/kumuluzee-version
- Owner: kumuluz
- License: other
- Created: 2019-04-05T08:08:01.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-11-24T10:34:27.000Z (over 4 years ago)
- Last Synced: 2025-04-09T19:55:52.086Z (about 2 months ago)
- Topics: jakartaee, java, javaee, kumuluz, kumuluzee, microservices, version, versioning
- Language: Java
- Homepage: https://ee.kumuluz.com
- Size: 47.9 KB
- Stars: 0
- Watchers: 13
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# KumuluzEE Version
[](https://travis-ci.org/kumuluz/kumuluzee-version)
KumuluzEE Version provides mechanisms to expose version details of your microservices.
## Usage
You can enable KumuluzEE Version by adding the following dependency to the project:
``` xml
com.kumuluz.ee.version
kumuluzee-version
${kumuluzee-version.version}
```
### KumuluzEE Version configuration
KumuluzEE Version will have disabled endpoint by default. You can change this with the KumuluzEE configuration
framework by setting the following key where version information will be exposed:
```yaml
kumuluzee:
version-info:
endpoint: /myCustomEndpoint
```
KumuluzEE Version will look for values to expose in a json file inside of the resources folder,
the filepath is `VERSION.json` by default.
The default filepath for this file can be changed with the KumuluzEE configuration framework by setting the following key:
```yaml
kumuluzee:
version-info:
file-path: test/MY_CUSTOM_.json
```
We can also specify our own custom values that will then be exposed on the servlet. Use the key
`kumuluzee.version-info.values.\`.
The following is an example of how to set the docker-image-name configuration value:
```yaml
kumuluzee:
version-info:
values:
docker-image-name: myDockerImageName
```
The easiest way to set this is as an environment variable KUMULUZEE_VERSION_VALUES_DOCKERIMAGENAME, which takes priority over
the yaml configuration.
### Example of VERSION.json
The following is an example of such a file:
``` json
{
"maven_group_id": "${project.groupId}",
"maven_artifact_id": "${project.parent.artifactId}",
"maven_version": "${project.version}",
"project_artifactId": "${project.artifactId}",
"git_commit_id": "${buildNumber}"
}
```
KumuluzEE Version expects the fields to be like ```${...}``` and to get filled by some external plugin. If a field
remains unfilled then a warning gets logged. A warning also gets logged if the field is filled with "".
## Changelog
Recent changes can be viewed on Github on the [Releases Page](https://github.com/kumuluz/kumuluzee-version/releases)
## Contribute
See the [contributing docs](https://github.com/kumuluz/kumuluzee-version/blob/master/CONTRIBUTING.md)
When submitting an issue, please follow the
[guidelines](https://github.com/kumuluz/kumuluzee-version/blob/master/CONTRIBUTING.md#bugs).
When submitting a bugfix, write a test that exposes the bug and fails before applying your fix. Submit the test
alongside the fix.
## License
MIT