Skip to content

Commit fa5b8c2

Browse files
Clarify that plugin depends on release cycle of client5
1 parent 41f0c01 commit fa5b8c2

File tree

2 files changed

+22
-11
lines changed

2 files changed

+22
-11
lines changed

README.adoc

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,11 @@ It allows managing library updates independently of plugins.
2222

2323
Replace the dependency to `org.apache.httpcomponents.client5:httpclient5` with the dependency to `apache-httpcomponents-client-5-api`.
2424

25+
Avoid version conflicts by using the https://github.com/jenkinsci/bom[Jenkins Plugin BOM] rather than depending on a specific version.
26+
2527
*Before:*
2628

29+
[source,xml]
2730
----
2831
<dependencies>
2932
...
@@ -38,13 +41,13 @@ Replace the dependency to `org.apache.httpcomponents.client5:httpclient5` with t
3841

3942
*After:*
4043

44+
[source,xml]
4145
----
4246
<dependencies>
4347
...
4448
<dependency>
4549
<groupId>org.jenkins-ci.plugins</groupId>
4650
<artifactId>apache-httpcomponents-client-5-api</artifactId>
47-
<version>5.2.1-1.0</version>
4851
</dependency>
4952
...
5053
</dependencies>
@@ -54,8 +57,11 @@ Replace the dependency to `org.apache.httpcomponents.client5:httpclient5` with t
5457

5558
Add the dependency to `apache-httpcomponents-client-5-api` *before* any of dependencies to those libraries to force maven to use `httpclient5` declared by `apache-httpcomponents-client-5-api`.
5659

60+
Avoid version conflicts by using the https://github.com/jenkinsci/bom[Jenkins Plugin BOM] rather than depending on a specific version.
61+
5762
*Before:*
5863

64+
[source,xml]
5965
----
6066
<dependencies>
6167
...
@@ -73,13 +79,13 @@ Add the dependency to `apache-httpcomponents-client-5-api` *before* any of depen
7379

7480
*After:*
7581

82+
[source,xml]
7683
----
7784
<dependencies>
7885
...
7986
<dependency>
8087
<groupId>org.jenkins-ci.plugins</groupId>
8188
<artifactId>apache-httpcomponents-client-5-api</artifactId>
82-
<version>5.2.1-1.0</version>
8389
</dependency>
8490
<dependency>
8591
<artifactId>somelibrary-using-httpclient</artifactId>
@@ -95,15 +101,16 @@ Add the dependency to `apache-httpcomponents-client-5-api` *before* any of depen
95101

96102
== Versioning
97103

98-
Version follows the pattern of `<org.apache.httpcomponents version>-<plugin version>`.
99-
104+
Version follows the pattern of `<org.apache.httpcomponents.client5 version>-<plugin version>`.
100105
This way it is clear what upstream dependency is offered and allows patch releases for the plugin itself if required.
101106

107+
Since `org.apache.httpcomponents.client5` artifacts have a release cycle that is independent from `org.apache.httpcomponents.core5` artifacts, the latter part of patch releases for this plugin.
108+
102109
== Release Notes
103110

104111
Release notes are recorded in https://github.com/jenkinsci/apache-httpcomponents-client-5-api-plugin/releases[GitHub Releases].
105112

106113
== License
107114

108-
* https://opensource.org/licenses/MIT[MIT License] - Plugin codebase
109-
* https://www.apache.org/licenses/LICENSE-2.0[Apache License 2.0] - Nested library
115+
* Plugin source and documentation - https://opensource.org/licenses/MIT[MIT License]
116+
* Nested library - https://www.apache.org/licenses/LICENSE-2.0[Apache License 2.0]

pom.xml

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
2+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
34
<modelVersion>4.0.0</modelVersion>
45

56
<parent>
@@ -15,16 +16,19 @@
1516
<packaging>hpi</packaging>
1617

1718
<properties>
18-
<revision>5.2.3</revision>
19+
<httpclient.version>5.2.1</httpclient.version>
20+
<httpcore.version>5.2.3</httpcore.version>
21+
22+
<revision>${httpclient.version}</revision>
1923
<changelist>-999999-SNAPSHOT</changelist>
2024
<jenkins.version>2.361.4</jenkins.version>
21-
<httpcore.version>${revision}</httpcore.version>
22-
<httpclient.version>5.2.1</httpclient.version>
25+
2326
<gitHubRepo>jenkinsci/apache-httpcomponents-client-5-api-plugin</gitHubRepo>
2427
</properties>
2528

2629
<name>Apache HttpComponents Client 5.x API Plugin</name>
27-
<description>Bundles Apache HttpComponents Client ${revision} and allows it to be used by Jenkins plugins</description>
30+
<description>Bundles Apache HttpComponents Client ${revision} and allows it to be used by Jenkins plugins
31+
</description>
2832
<url>https://github.com/${gitHubRepo}</url>
2933

3034
<licenses>

0 commit comments

Comments
 (0)