From 8afeecf8f384ce75c8cb1acc8feee005f8b667f6 Mon Sep 17 00:00:00 2001
From: Christian Del Monte <register@cdelmonte.de>
Date: Sat, 14 Oct 2023 16:39:46 +0200
Subject: [PATCH] Update readme

---
 README.md                 |  96 +++++++++++++++++++++++---------------
 docs/img/silpion_logo.png | Bin 3493 -> 0 bytes
 docs/index.md             |  25 ++++++++--
 3 files changed, 80 insertions(+), 41 deletions(-)
 delete mode 100644 docs/img/silpion_logo.png

diff --git a/README.md b/README.md
index 7f642fdc..3ea72aac 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@
 [![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/bitbucket-push-and-pull-request.svg?color=blue)](https://plugins.jenkins.io/bitbucket-push-and-pull-request)
 [![Gitter](https://badges.gitter.im/jenkinsci/bitbucket-push-and-pull-request-plugin.svg)](https://gitter.im/jenkinsci/bitbucket-push-and-pull-request-plugin)
 
-<img src="docs/img/logo-head.svg" width="192">
+<img src="docs/img/logo-head.svg" width="192" alt="jenkins logo">
 
 - [Bitbucket Push and Pull Request Plugin](#bitbucket-push-and-pull-request-plugin)
 - [Introduction](#introduction)
@@ -32,11 +32,21 @@
 - [Thanks and Acknowledgments](#thanks-and-acknowledgments)
 
 
+# Compatibility
+
+**Starting from version 3.x.x** the Plugin is compatible with:
+- Jenkins version: >= **2.361.4**
+- Java version: **11**
+
+The version 2.x.x of the Plugin is compatible with:
+- Jenkins >= v2.138.2
+- Java 8
+
 # Introduction
 
-Plugin for Jenkins **v2.138.2 or later**, that triggers builds on Bitbucket's push and pull requests events.
+Plugin for Jenkins **v2.361.4 or later**, that triggers builds on Bitbucket's push and pull requests events.
 
-The new features introduced by Bitbucket Push and Pull Request 2.x.x are:
+Some of the features introduced by Bitbucket Push and Pull Request are:
 
 - build state notification
 - support of pull requests for Bitbucket cloud (rest api v2.x+ with mercurial and git) and bitbucket Server (5.14+ with git)
@@ -49,7 +59,16 @@ Bitbucket Push and Pull Request supports the
 - Bitbucket cloud rest api v2.x+ and later (with git and mercurial repos)
 - Bitbucket server 5.14+ and later (with git repos)
 
- # Before you start
+
+# Before you start
+
+The version 2.x.x of the Plugin is compatible with:
+- Jenkins >= v2.138.2 
+- Java 8
+
+Otherwise, The version 3.x.x of the Plugin compatible with:
+- Jenkins version: >= 2.361.4
+- Java version: 11
 
 Bitbucket Push And Pull Request Plugin will not work if the old Bitbucket plugin <https://plugins.jenkins.io/bitbucket> is still installed. So, please de-install from Jenkins the previous Bitbucket plugin if you want to use this new one.
 
@@ -102,11 +121,11 @@ _Please note: the branch, related to the events which trigger the builds, must b
 
 ### Authentication for state notification and generally when using the Bitbucket REST API
 
-TYPE | BB CLOUD | BB SERVER | JENKINS CREDENTIALS | NOTES
---- | :-- | :---  | :--- | ---
-Username & Password | X | X | Username with password| deprecated by bbc, will be removed in march 2022
-HTTP access token | - | X | Secret Text | [learn more about HTTP tokens](https://confluence.atlassian.com/bitbucketserver/http-access-tokens-939515499.html)
-OAuth consumers  | X | - | Secret Text | [learn more about Oauth Consumers](https://support.atlassian.com/bitbucket-cloud/docs/use-oauth-on-bitbucket-cloud/)
+| TYPE                | BB CLOUD | BB SERVER | JENKINS CREDENTIALS    | NOTES                                                                                                                |
+|---------------------|:---------|:----------|:-----------------------|----------------------------------------------------------------------------------------------------------------------|
+| Username & Password | X        | X         | Username with password | deprecated by bbc, will be removed in march 2022                                                                     |
+| HTTP access token   | -        | X         | Secret Text            | [learn more about HTTP tokens](https://confluence.atlassian.com/bitbucketserver/http-access-tokens-939515499.html)   |
+| OAuth consumers     | X        | -         | Secret Text            | [learn more about Oauth Consumers](https://support.atlassian.com/bitbucket-cloud/docs/use-oauth-on-bitbucket-cloud/) |
 
 1. you can set globally the credentials used by the plugin for the state notification
 2. you can set for each job the credentials used by the plugin for the state notification, overwriting the global credentials
@@ -114,16 +133,16 @@ OAuth consumers  | X | - | Secret Text | [learn more about Oauth Consumers](http
 
 ## Bitbucket Events supported by the plugin
 
-FILTER | BB CLOUD | BB SERVER | NOTES
---- | :-- | :---  | ---
-Pull Request Created | X | X |
-Pull Request Updated | X | X |
-Pull Request Declined | X | X |
-Pull Request Merged | X | X |
-Push | X | X |
-Comment Created | X | X |
-Comment Updated | X | - | If a user updates the same comment with not much time in between, Bitbucket only sends the event request the first time the comment is updated.
-Comment Deleted | X | - |
+| FILTER                | BB CLOUD | BB SERVER | NOTES                                                                                                                                           |
+|-----------------------|:---------|:----------|-------------------------------------------------------------------------------------------------------------------------------------------------|
+| Pull Request Created  | X        | X         |                                                                                                                                                 |
+| Pull Request Updated  | X        | X         |                                                                                                                                                 |
+| Pull Request Declined | X        | X         |                                                                                                                                                 |
+| Pull Request Merged   | X        | X         |                                                                                                                                                 |
+| Push                  | X        | X         |                                                                                                                                                 |
+| Comment Created       | X        | X         |                                                                                                                                                 |
+| Comment Updated       | X        | -         | If a user updates the same comment with not much time in between, Bitbucket only sends the event request the first time the comment is updated. |
+| Comment Deleted       | X        | -         |                                                                                                                                                 |
 
 ### Some examples
 
@@ -163,25 +182,25 @@ The reason for that is the wish to guarantee consistency between the two plugins
 
 # Environment variables
 
-NAME | VALUE | SCOPE | BB TYPE | NOTES
---- | :-- | :--- | :--- | ---
-BITBUCKET_TARGET_BRANCH | target branch | PR + P | C + S |
-BITBUCKET_ACTOR | actor name | PR + P | C + S |
-BITBUCKET_PAYLOAD | Complete payload as json string | PR + P | C + S |
-BITBUCKET_X_EVENT | x-event which triggered the plugin | PR + P | C + S |
-BITBUCKET_SOURCE_BRANCH | source branch | PR | C + S |
-BITBUCKET_PULL_REQUEST_TITLE | PR title | PR | C + S |
-BITBUCKET_PULL_REQUEST_ID | id | PR | C + S |
-BITBUCKET_PULL_REQUEST_LINK | link | PR | C + S |
-BITBUCKET_PULL_REQUEST_DESCRIPTION | PR description | PR | C + S |
-BITBUCKET_PULL_REQUEST_COMMENT_TEXT | Comment of BB Cloud Pull Request | PR | C + S |
-BITBUCKET_PULL_REQUEST_LATEST_COMMIT_FROM_SOURCE_BRANCH | Latest commit hash on the source branch | PR | C + S | 
-BITBUCKET_PULL_REQUEST_LATEST_COMMIT_FROM_TARGET_BRANCH | Latest commit hash on the target branch | PR | C + S | 
-BITBUCKET_REPOSITORY_UUID | Repository identifier | P | C |
-BITBUCKET_REPOSITORY_ID | Repository identifier | P | S |
-BITBUCKET_REPOSITORY_URL | Repository URL | PR | C |
-REPOSITORY_LINK | Repository link | P | C | Deprecated: to remove in 2.6
-REPOSITORY_NAME | Repository name | P | S | Deprecated: to remove in 2.6
+| NAME                                                    | VALUE                                   | SCOPE  | BB TYPE | NOTES                        |
+|---------------------------------------------------------|:----------------------------------------|:-------|:--------|------------------------------|
+| BITBUCKET_TARGET_BRANCH                                 | target branch                           | PR + P | C + S   |                              |
+| BITBUCKET_ACTOR                                         | actor name                              | PR + P | C + S   |                              |
+| BITBUCKET_PAYLOAD                                       | Complete payload as json string         | PR + P | C + S   |                              |
+| BITBUCKET_X_EVENT                                       | x-event which triggered the plugin      | PR + P | C + S   |                              |
+| BITBUCKET_SOURCE_BRANCH                                 | source branch                           | PR     | C + S   |                              |
+| BITBUCKET_PULL_REQUEST_TITLE                            | PR title                                | PR     | C + S   |                              |
+| BITBUCKET_PULL_REQUEST_ID                               | id                                      | PR     | C + S   |                              |
+| BITBUCKET_PULL_REQUEST_LINK                             | link                                    | PR     | C + S   |                              |
+| BITBUCKET_PULL_REQUEST_DESCRIPTION                      | PR description                          | PR     | C + S   |                              |
+| BITBUCKET_PULL_REQUEST_COMMENT_TEXT                     | Comment of BB Cloud Pull Request        | PR     | C + S   |                              |
+| BITBUCKET_PULL_REQUEST_LATEST_COMMIT_FROM_SOURCE_BRANCH | Latest commit hash on the source branch | PR     | C + S   |                              |
+| BITBUCKET_PULL_REQUEST_LATEST_COMMIT_FROM_TARGET_BRANCH | Latest commit hash on the target branch | PR     | C + S   |                              |
+| BITBUCKET_REPOSITORY_UUID                               | Repository identifier                   | P      | C       |                              |
+| BITBUCKET_REPOSITORY_ID                                 | Repository identifier                   | P      | S       |                              |
+| BITBUCKET_REPOSITORY_URL                                | Repository URL                          | PR     | C       |                              |
+| REPOSITORY_LINK                                         | Repository link                         | P      | C       | Deprecated: to remove in 2.6 |
+| REPOSITORY_NAME                                         | Repository name                         | P      | S       | Deprecated: to remove in 2.6 |
 
 # Dsl Job actions for Bitbucket Push and Pull Request Trigger
 
@@ -557,6 +576,7 @@ job('example-pull-request-created-updated') {
       shell('echo START pull request created')
   }
 }
+
 ```
 
 ### Valid for pipeline with job-dsl 1.77+ (and before)
diff --git a/docs/img/silpion_logo.png b/docs/img/silpion_logo.png
deleted file mode 100644
index 85c2c38e5813635ae8ee880996b9bce8d5314ef2..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001

literal 3493
zcma)9c|4T+8lP}vEE9&@q|P)#WXvYBWE(S<xt46FoQh-2j4_$bEDVx0k}TOyqb!4T
z<fMgcNz#HOlbo`KxKucCoE%cR!>M!6ANO-V_x*g{_kDi9_xXOG@9$aucvC$+oHbPS
zRRI8i2HAz=Eq~9;?>#EY@@FeHLMDH06FT|{eYnBG2nwGLAker$bO@PEVbHzl6k23h
zC*2wVP};)u^%MHJyWy!^wgqL~$3o2J$<Y9SwVjwpp@!0hkRUpP$+3aHyLAT&VbW}%
zhxWN6+<8QL2-78sPxp!P@TEqDQgJk>oh`&#jF%Iz=|T!b%w}-}c(Dz1gBLHi*SFzN
z$cBqB)CT&eC_i^k2$9RDL-tu%!KetNB?N=BK<=}`;4tP8lza_GVBshP41vS%L*o%B
z$d?N$kH)73<Go2vUt-BuHqa2EkcWrEBO)R!BG49GJ_C-#;c##S3XVd-<Q_0VBu7XQ
z!#D!NuM8x*fXZj`giJ06vd%~e;);YeP`T1SkHF@+yZ=SZ5qwFMJY{e(g$GAkAmD8F
z`nfi|1wwE7e`NeuZ-H+lj}G^y3%DXaRbG!^!>?d@?*4b6uZ}e8Uw%9hpS5vL8Wm1w
z(b;s4P#_nD+)yM}jz7R>$_q$gk+@XR`d2c^1}YLUX?UxBj#g+K!U}6ebV4FY4g@Pl
z6bXyP5FH6b2TKHIJ=i+I-+}TS3z{5@BVy1vk`n>zh`}O}j+QtA){5X{W##Bd+Gj<?
z62D@}9D$I+q0-lbu49@1!Q%cW7Ek2UDMBvam&;{+Z51+$B@zhv>)Q|_aicjPd)z5h
zCP&B>gqW_^^NV6SpBYZ4Iq|t{$VNf%%>SZ;ibNx^2rLbTqoIOemO(+mFf4^;1w&cU
z=x8hwL$gF9p<nQ{za{T$4*oAZTrP@6#S5827X3@d5?I177K^#wHFy?<!;q&3MxzH)
zL@XiH)`!XB$-5Ee#$|9}KGYCCGgufUV!)jFB09$!zTTuPrkrEL`jZa+w;&taf9vY6
zp7K#yH~*SZ`QooBr*q_^&6m$GXEdW2005ekNd#Z<;H>{p*jv2LNay5d-u8wtvr|5s
zJidunjZ=l_+M5B^e*M%|2`N`_`v$9Pa4BKNmuFG*eRQo>LO;Z0_duxAJ=YWD!>gvL
zHFmLUSq{?Wf`(;GqxED%pns`|`6{NtLSrGi#lrMaSJUH#LI>$QdF=H2TQj|zB8|Kz
zM3Lb4C*u43HKUca?aHd<XnTeF=X7=U`72#C|DA+@)P(-j_x>uq^`6Ny{4EZ#hpxrB
z3Qz4A4zE1SemC*4a8zw>CCR&_-r^7>(Clr0`nRXwdH3CETiE?%U^$uHbnSGh^~1sN
zHI<`T^O)MHdriZ$h}a__XkGXP^utKwpK5M&tQA_G`V_EWtNeUf?Isyy$lJ4fY_92y
z!IayfbE)X8W$pGkbfzF=@`yo=EW>;DIzU$!$jZS)IuFrgvc1wP=#RDuqq7bPi#geT
z(s|-ovg6CXFgf<#4$WHl$5*B5(mZr-^?aB@mtFquHIO!DU_l<OJT0HOdV9-$)$aI<
z+tZrA*%n<&IfBT!Bx`1YHY3ia<@Q#+&H_yPsm_^`hn3@tm84rXIXBPrP8nnkrPLWs
zhTjGC4i~kG_xyURvHjTP)1_C7D~~^vrXYJuj=gzkKYVM;WJBgTP-fC9r%Q(|nT7K7
zj29A#i!E7Xt&0$Sa9GAWXi7N!%1f;l_=_}{`+Gq5$i=sfL0dJS0<%iQPspiJmv~oy
z3kcr1`MgaQI;-Z4)0N&oG|or}8h><~_M~KgGR@rnLYA*pgeDvb?oHy1m2UfZ@KD*(
z13=-cMb(1mEuP<AojstZ7o(#w_qJTC+Roa3rrO1@rCpQd1&+KJ=daRre{=uH_CE3G
z<FxNj)*Zjx2s6|kI4{_>PruDAoSCO*c~I%fP-0~a`<KGIXD*CUy!#5{%2&(h6A>wo
zUfr6?u~VR&y!%EGo%w5ek05W?)L7DBHUrZ;V3&3$?ZxQw_@gi%ScqGGDfnEQV)G9`
zZ%_!Df7@Y%WJxkV9-?=G7&x5E>X#Uvvb-1-yf8TlnkDyF5uarIe8^-gsO#jFi;wTE
z><3Y-Q{v#yjBnk5oHb0&qOxqFA?<||ErNN&&q;OalwSr5KCLO(Deq4}n_Ae$RTPeW
zs**L=L%g~uR$-oRKpN-=T=xr@2<u^;U{}8c^Fq}`;`I@`v-iGx8`<on(8Xr0oU&C)
zbgv%Lp15c}r4rO_9#kLR5G$&uCoB%UdH$p^MAkSTtLTMn|AUPJBa&+yOQdtW-`g8r
zd#k8$#*ExXk2_E7(4UO-4LAtB=AN*sUyUA+dS(3LQYSlLGa4}~TO)L?cG{@5`F{cz
z5w}-3fSnqiCL6{0DL9G|Lx*B&W*0T}gyhmjS*x}os&S%%|MNi-D6|SxUzV{<dM)!5
z1u|ne`OU?(6{`bLPXt}Q>76?izAX_<J8VCYR2jNi?=Y?O$*zoa9_yaA>TmjjrvM7M
zayN3fMo6Ll!_D`#bd18{H}zDOsHg7-6Y@Ha%_qyM4cuIm!cdylif4UXXEILaGl~-w
zH?ugmbAQj<c_peDU|7-pzO(%U(Jri2^k!MuQApJ6$qPRLbaNnvlP+DaG&n2qLJ>yx
zqXZJQ?g2fe6Utr;aS!N(I@G$Ye5XqKKs#6Qa=vA8T6C_$Lk5R;YP#_=CGje8O)w)`
z8L-<r-9~e_|2ZMo(RK;gTSGR^3|-x4F!rGf70Zyl6^tKQbgOj9f&&OqwcAv>%&dv4
zik7svrE_nxaHpH=%hP@j-F1y^mTr$I8qdYy6aToYuU7M8>LVpCaCB*B!O)V=kgx4v
zeQ4mY{p&s(Y|~^>WkrAHxw`2Wd#wv(vzaf)7poj^v_g^79j8H(!%1l{w5fK>uWF|r
z#^3PG!dTx(be4^2t(=z%=H?%yi1TO9XQn$3X0#o2OkV5GJ@#I!L3a2~iP1Ez?y02I
zJV~-23KnKJR%=NbdwUXo*OHJ8Oas)iKbhbguuIzQ$awgczKTXM=!dbDVegWgW*^@E
z@Li}`OB}EepP<V|Z7KyyPVK&w@d09R{;8pqtmyiIPm0>5QZRujDhP(-_8;87N_zW`
z#|32vFQ~`=Slf72kfH52HIaiTmOS2ps!9nkSEx@4Y|xu70`4MUGk3!;Rpy)Yd4&J-
za>h}CYYNrq*+<zqvhGoQ(n_b6n4?jm%=RdoynSIHw;9}S-g(<Q(T8{)dq8z=M0+}I
zNqy4ip97YmuU%FRV*d3nFZT42pOQh+4^fwmg-*c<Sm$#L$lleaY@zG;X1&VzP$b}L
z=g&H+A<;tvz9E)B77v-ArIR&US<z*HZ=c88aQ8!VntW#47c;PqlW#uy^SKK`{vyEQ
ze&DNbRDm7(6N~-5k4VO%`}%dx#v!_AJG<*b1WUT_;&1M?*B!@iF?u)3xb)rGHCsHY
zVlMY^m9h_B`mDdY-6TlmgN*R12_XfasVGi6-^Gl^oJn#kZ|s;T1jdFt4J{s3a|=6a
zVd+<|6bXC*zh%_TXq`68xgdNqfqeb6-CdQucTe7dT?lRt`1>_;@HG>+L7=4kV_Y4>
z#6NprJhA?HYM44^Ic`|Z82aHHa9fJ9$MI@h-k=x5WQWt`p)Io0CL_*#pIcfIi8oMX
zYu12$Ra(!FyeTv)HgHORb}wb8GA$VK2?~CYKh>jIh{D~C|IMX+&U5)CpfLe3<9U14
zG{#wbG;8IVP4Pk^e1UPi`C`VLGcCION!;VZFJ<HH585)RKQyR~w+`MUobOVT%wo!G
z!gWq3S|VI)9VTq!J1n$a-TUl!Y`Z?wyR_8={ISTdASGg}dWYMx=N=v1n7|?7YarXa
zTRY%#`^vC!0C;m}q?awXi}_-FE|7Tiz>8Efot-L=l~_3gso9E0nve5<#S`guj4DmZ
z$+f+xnOJa_I^)WSabZN2r`QM)8kF(d!sj|C+8Q%n4`cl-_}Iy^zIt)GdC=7k7Bsf3
z;E?pEl-61B;^8A!m3p-}a4=`3lly!@5Hg%MAMuW?cu@7h(`#k2)z-DEZld`+T3eY$
zMM~MN_gl)l?U+vjJr1}m7O6f+0sAGGL}8c$qZ}o8pkHs#$Ui)!Kk0r}LjdSEi!_fm
S1t_imIFTJaNYxI33I7Id&-H5n

diff --git a/docs/index.md b/docs/index.md
index 46e91d38..9e06cce1 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -32,11 +32,21 @@
 - [Thanks and Acknowledgments](#thanks-and-acknowledgments)
 
 
+# Compatibility
+
+**Starting from version 3.x.x** the Plugin is compatible with:
+- Jenkins version: >= **2.361.4**
+- Java version: **11**
+
+The version 2.x.x of the Plugin is compatible with:
+- Jenkins >= v2.138.2
+- Java 8
+
 # Introduction
 
-Plugin for Jenkins **v2.138.2 or later**, that triggers builds on Bitbucket's push and pull requests events.
+Plugin for Jenkins **v2.361.4 or later**, that triggers builds on Bitbucket's push and pull requests events.
 
-The new features introduced by Bitbucket Push and Pull Request 2.x.x are:
+Some of the features introduced by Bitbucket Push and Pull Request are:
 
 - build state notification
 - support of pull requests for Bitbucket cloud (rest api v2.x+ with mercurial and git) and bitbucket Server (5.14+ with git)
@@ -49,7 +59,16 @@ Bitbucket Push and Pull Request supports the
 - Bitbucket cloud rest api v2.x+ and later (with git and mercurial repos)
 - Bitbucket server 5.14+ and later (with git repos)
 
- # Before you start
+
+# Before you start
+
+The version 2.x.x of the Plugin is compatible with:
+- Jenkins >= v2.138.2
+- Java 8
+
+Otherwise, The version 3.x.x of the Plugin compatible with:
+- Jenkins version: >= 2.361.4
+- Java version: 11
 
 Bitbucket Push And Pull Request Plugin will not work if the old Bitbucket plugin <https://plugins.jenkins.io/bitbucket> is still installed. So, please de-install from Jenkins the previous Bitbucket plugin if you want to use this new one.