Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
1 addition
and
180 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,180 +1 @@ | ||
| # Incrementals | ||
|
|
||
| See [JEP-305](https://github.com/jenkinsci/jep/blob/master/jep/305/README.adoc) for context. | ||
|
|
||
| ## Usage in plugin POMs | ||
|
|
||
| Since most Jenkins repositories host plugins, this use case will be documented first. | ||
| You must be using parent POM version [3.9](https://github.com/jenkinsci/plugin-pom/blob/840ac3020a0a243dd243ed7156a22dae1e3c35fe/CHANGELOG.md#39) or later. | ||
|
|
||
| ### Enabling consumption of incrementals | ||
|
|
||
| If your plugin has (or may have) dependencies on incremental versions, run: | ||
|
|
||
| ```bash | ||
| mkdir -p .mvn | ||
| echo -Pconsume-incrementals >> .mvn/maven.config | ||
| git add .mvn | ||
| ``` | ||
|
|
||
| (See [this guide](https://maven.apache.org/docs/3.3.1/release-notes.html#JVM_and_Command_Line_Options) for details on the `.mvn` directory.) | ||
|
|
||
| This profile merely activates access to the [Incrementals repository](https://repo.jenkins-ci.org/incrementals/). | ||
|
|
||
| ### Enabling production of incrementals | ||
|
|
||
| To produce incremental artifacts _from_ your plugin, first edit your `pom.xml`. | ||
| If your plugin declares | ||
|
|
||
| ```xml | ||
| <version>1.23-SNAPSHOT</version> | ||
| ``` | ||
|
|
||
| then replace that with | ||
|
|
||
| ```xml | ||
| <version>${revision}${changelist}</version> | ||
| ``` | ||
|
|
||
| and then in the `<properties>` section add | ||
|
|
||
| ```xml | ||
| <revision>1.23</revision> | ||
| <changelist>-SNAPSHOT</changelist> | ||
| ``` | ||
|
|
||
| If you have a multimodule reactor build, the new `properties` need be defined only in the root POM, | ||
| but every child POM should use the edited `version` to refer to its `parent`. | ||
| (It should _not_ override the `version`.) | ||
| Intermodule `dependency`es may use `${project.version}` to refer to the `version` of the sibling. | ||
|
|
||
| Also change | ||
|
|
||
| ```xml | ||
| <scm> | ||
| <!-- … --> | ||
| <tag>HEAD</tag> | ||
| </scm> | ||
| ``` | ||
|
|
||
| to | ||
|
|
||
|
|
||
| ```xml | ||
| <scm> | ||
| <!-- … --> | ||
| <tag>${scmTag}</tag> | ||
| </scm> | ||
| ``` | ||
|
|
||
| Now run | ||
|
|
||
| ```bash | ||
| mkdir -p .mvn | ||
| echo -Pmight-produce-incrementals >> .mvn/maven.config | ||
| echo .flattened-pom.xml >> .gitignore | ||
| ``` | ||
|
|
||
| Finally, configure [git-changelist-maven-extension](https://github.com/jglick/git-changelist-maven-extension) in `.mvn/extensions.xml`: | ||
| <!-- TODO HOSTING-549 link to official home --> | ||
|
|
||
| ```xml | ||
| <extensions xmlns="http://maven.apache.org/EXTENSIONS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/EXTENSIONS/1.0.0 http://maven.apache.org/xsd/core-extensions-1.0.0.xsd"> | ||
| <extension> | ||
| <groupId>io.jenkins.tools</groupId> | ||
| <artifactId>git-changelist-maven-extension</artifactId> | ||
| <version>1.0-alpha-3</version> | ||
| </extension> | ||
| </extensions> | ||
| ``` | ||
|
|
||
| You may now | ||
|
|
||
| ```bash | ||
| git add .mvn .gitignore pom.xml | ||
| ``` | ||
|
|
||
| and commit and push your edits. | ||
|
|
||
| If this becomes the head of a pull request built on ci.jenkins.io, | ||
| and the pull request is up to date with its target branch, | ||
| and the build is stable, | ||
| the artifact will be automatically deployed to the Incrementals repository. | ||
| Pending [INFRA-1598](https://issues.jenkins-ci.org/browse/INFRA-1598), | ||
| you may need to add a `github` field to your plugin’s entry | ||
| in [`repository-permissions-updater`](https://github.com/jenkins-infra/repository-permissions-updater). | ||
|
|
||
| To produce equivalent artifacts in your local repository while working offline: | ||
|
|
||
| ```bash | ||
| mvn -Dset.changelist -DskipTests clean install | ||
| ``` | ||
|
|
||
| If you do not select the `-Dset.changelist` option, you will create a regular `*-SNAPSHOT` artifact. | ||
| (And that is what you _must_ do if you have any local modifications or untracked files.) | ||
|
|
||
| ### Production _and_ consumption | ||
|
|
||
| A single plugin may both consume Incrementals releases, and produce its own. | ||
| Just make both kinds of edits. | ||
| (`.mvn/maven.config` may have multiple lines.) | ||
|
|
||
| ### Running Maven releases | ||
|
|
||
| You may still use the Maven release plugin (MRP) when `might-produce-incrementals` is activated: | ||
|
|
||
| ```bash | ||
| mvn -B release:{prepare,perform} | ||
| ``` | ||
|
|
||
| The released artifacts should have sensible metadata. | ||
| (You may notice that they deploy a “flattened” POM file, but this should not break anything.) | ||
| However, after performing a traditional release, to resume being able to produce incrementals you must run: | ||
|
|
||
| ```bash | ||
| mvn help:evaluate -Dexpression=project.version -Doutput=version && \ | ||
| mvn versions:set -Ddollar='$' -DnewVersion='${dollar}{revision}${dollar}{changelist}' -DgenerateBackupPoms=false && \ | ||
| mvn versions:set-property -Dproperty=revision -DnewVersion=`sed -e 's/-SNAPSHOT$//' < version` -DgenerateBackupPoms=false && \ | ||
| rm version | ||
| ``` | ||
|
|
||
| <!--- TODO JENKINS-50693 publish this as a packaged script somewhere ---> | ||
|
|
||
| and commit and push the resulting `pom.xml` edits. | ||
|
|
||
| ## Usage in other POMs | ||
|
|
||
| From repositories with POMs not inheriting from `org.jenkins-ci.plugins:plugin` you can follow similar steps to use Incrementals. | ||
| If you inherit from `org.jenkins-ci:jenkins`, the same profiles are available; | ||
| otherwise you will need to copy the definitions of the `consume-incrementals`, `might-produce-incrementals`, and `produce-incrementals` profiles from `org.jenkins-ci:jenkins`, | ||
| as well as the `incrementals.url` and `scmTag` properties, | ||
| into your parent POM or directly into your repository POM. | ||
| Some adjustment of `maven-enforcer-plugin` configuration may also be necessary. | ||
|
|
||
| ## Offline testing | ||
|
|
||
| If you wish to test usage offline, run | ||
|
|
||
| ```bash | ||
| docker run --rm --name nexus -p 8081:8081 -v nexus-data:/nexus-data sonatype/nexus3 | ||
| ``` | ||
|
|
||
| add to your `~/.m2/settings.xml`: | ||
|
|
||
| ```xml | ||
| <servers> | ||
| <server> | ||
| <id>incrementals</id> | ||
| <username>admin</username> | ||
| <password>admin123</password> | ||
| </server> | ||
| </servers> | ||
| ``` | ||
|
|
||
| and then add to command lines consuming or producing incremental versions: | ||
|
|
||
| ``` | ||
| -Dincrementals.url=http://localhost:8081/repository/maven-releases/ | ||
| ``` | ||
|
|
||
| or define an equivalent profile in local settings. | ||
| Moved [here](https://github.com/jenkinsci/incrementals-tools/blob/master/README.md). |