| Table of Contents |
|---|
| Excerpt | ||
|---|---|---|
| ||
STATUS: |
...
implemented as of 2017-11-15 |
Rationale
We have a number of automated processes which make use of the Git repositories as a source of truth:
...
In the future, we may look into other automation, such as:
...
- automatically maintaining a README.md which points to documentation URLs or the build Job
- setting GitHub repository topics
Therefore it is proposed to allow the existence of a Sling module descriptor file in the root of each Git repository. If no descriptor exists, the module is processed by various tools in the default manner. If it exists, the tools must inspect it for custom settings and apply them.
...
The module file will be named .sling-module.xmljson . It is a "dotfile" as it is not usually touched during regular development. The XML JSON format allows easy consumption from various tools and , compared to JSON, allows defining comments, including the Jenkins scripted pipelines. A previous version of the module descriptor used XML, which also allowed comments, but unfortunately it's not easily readable from Jenkins scripted pipelines.
Rather than listing a specification, a full example is provided below. Notice that all JSON members are optional:
| Code Block | ||||
|---|---|---|---|---|
| ||||
<sling-module> <jenkins> <!-- settings inspected by Jenkins --> <jdks> <!-- replaces the default jdks when present --> <jdk>1.8</jdk> <jdk>9</jdk> </jdks> <downstreamProjects> <!-- adds more downstream projects when present --> <downstreamProject>sling-org-apache-sling-launchpad-testing</downstreamProject> </downstreamProjects> <archivePatterns> <!-- adds more archive patterns when present --> <archivePattern>{ "jenkins": { "jdks": [ 8, 9 ], "operatingSystems": [ "windows", "linux" ], "archivePatterns": [ "**/sling/logs/error.log</archivePattern> </archivePatterns> <!-- Additional parameters to pass to the Maven invocation --> <additionalMavenParams>log" ], "mavenGoal": "install", "additionalMavenParams": "-Dorg.ops4j.pax.url.mvn.repositories=http://repo.maven.apache.org/maven2@id=apache-releases,http://repository.apache.org/content/groups/snapshots-group@snapshots@noreleases@id=apache-snapshots</additionalMavenParams> <!-- rebuilds the job periodically when defined --> <rebuildFrequency>@weekly</rebuildFrequency> <!-- No Jenkins job generated when set to false --> <enabled>false</enabled> </jenkins> <aggregator> <!-- setting inspected by sling-aggregator tooling --> <groups> <!-- generates repo "groups" settings and separate Maven profile in the global reactor pom, when present --> <group>scripting</group> <group>sightly</group> </groups> </aggregator> </sling-module>snapshots", "upstreamProjects": [ "sling-org-apache-sling-starter" ], "rebuildFrequency": "@weekly", "enabled": false, "emailRecipients": [ "dev@sling.apache.org" ], "branches": { "master": { "nodeLabel": "git-websites", "additionalMavenParams": "-Ppublish-site -Dmsg=\"Automatic website deployment\"" } }, "sonarQubeEnabled": false, "sonarQubeUseAdditionalMavenParams": false, "sonarQubeAdditionalParams": "-PsonarQubeProfile" } } |
Description
| JSON member | Type | Possible Values |
|---|---|---|
jenkins.jdks | Array of Numbers | 8-22 |
jenkins.operatingSystems | Array of Strings |
|
Default Values
The following JSON members have default values. All others are just not set/empty. Just set them explicitly to a value, if the default does not fit your needs.
| JSON member | Default value |
|---|---|
jenkins.jdks |
|
jenkins.operatingSystems |
|
jenkins.rebuildFrequency |
|
jenkins.sonarQubeEnabled | true |
jenkins.sonarQubeUseAdditionalMavenParams | true |
(Source: https://github.com/apache/sling-tooling-jenkins/blob/master/vars/slingOsgiBundleBuild.groovy)
Samples
Building with multiple JDK versions and operating systems
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"jenkins": {
"jdks": [8, 11, 17],
"operatingSystems": ["linux", "windows"]
}
} |
The first JDK/Operating System is always the reference one (i.e. the one from which the build artifacts are deployed to the Maven repository and which are used for the SonarCloud execution)