Build Properties
A number of properties affect the build. They can be provided via Gradle or Java system property. They can also be injected from the environment by converting to uppercase and replacing dots by underscores. Many of these are automatically injected when running on Gitlab
Property |
Description |
Injected in CI? |
Local Build? |
|
The Gitlab Project URL. |
Y |
For documentation building for a real URL is required. |
|
The Gitlab Project Path. |
Y |
- |
|
The Gitlab server URL |
N |
This is used in tests to override the Gitlab server and point it to a mock server. |
|
The Discord invitation URL |
Y |
Only if a correct URL is required. A non-resolvable URL is otherwise injected. |
|
A read/write token for accessing the Gitlab API . |
Y |
Only when running |
|
The name of the user that interacts with Gitlab. |
Y |
Only when running |
|
The key for signing artifacts that will be pushed to Sonatype’s OSSRH |
Y |
Only needed when publishing locally, do |
|
The key for signing artifacts that will be pushed to Sonatype’s OSSRH |
Y |
Only needed when publishing locally, do |
|
The Mastodon access token |
Y |
When testing announcement against Mastodon, this is required. |
|
The Mastodon server to send announcements to. It defaults to |
N |
Not needed, as there is a default value. Only supply when testing against another Mastodon account. |
Due to the GrGit used under the hood, there are two authentication properties that need to be supplied either via environment variables or system properties.
There are required when building documentation for publication - publishDocumentation task.
For local building, the token does not need to have repository write permissions.
You can create the appropriate token in your Gitlab profile page.
System property |
Environment variable |
|
|
|
|