Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(dependencies): Tracks Jenkins' three last LTS versions. #6717

Merged
merged 21 commits into from
Oct 5, 2023

Conversation

gounthar
Copy link
Contributor

@gounthar gounthar commented Sep 28, 2023

In various parts of the documentation, we can see references to one or several Jenkins LTS versions, like in:

Link 1
Link 2
Link 3

Not all of them are consistent, and contributors, instead of bots, still maintain some.
There is already a Ruby script that helps with keeping the references up to date, but it does not address all the parts in the documentation.
As we are already using updatecli for other dependency updates, I propose to use it to keep track of the Jenkins LTS versions too.

I searched for PLACEHOLDER_RECENT_LTS_POINT_HIGHS, PLACEHOLDER_RECENT_LTS_POINT_HIGH, corebaseline, 2.401.3, 2.387, 2.375, and bom- to know what files I should make changes in, and only found four:

There is also this file that deals with Jenkins LTS versions, but it looks like it presents a fictional situation, so I'm not 100% sure this should be kept up to date.

I think this could be ameliorated, I'm not particularly proud of this manifest, but at least, it works.

For reference, this updatecli manifest has generated this PR on my fork of jenkins.io.

Bump last three Jenkins' LTS versions in the documentation

Bump Jenkins super old BOM artifact version in the "improve a plugin tutorial"

1 file(s) updated with "${1}1654.vcb_69d035fa_20${3}": * content/doc/developer/tutorial-improve/update-base-jenkins-version.adoc

Bump Jenkins minimum BOM artifact in the "plugin-bill-of-materials" page

1 file(s) updated with "${1}bom-2.387.x${3}": * content/doc/developer/tutorial-improve/use-plugin-bill-of-materials.adoc

Bump Jenkins minimum BOM artifact version in the "plugin-bill-of-materials" page

1 file(s) updated with "${1}2465.va_e76ed7b_3061${3}": * content/doc/developer/tutorial-improve/use-plugin-bill-of-materials.adoc

Bump Jenkins minimum BOM artifact version in the "improve a plugin tutorial"

1 file(s) updated with "${1}2465.va_e76ed7b_3061${3}": * content/doc/developer/tutorial-improve/update-base-jenkins-version.adoc

Bump Jenkins minimum LTS version in the recommended versions section

1 file(s) updated with "${1}2.401.3${3}": * content/doc/developer/plugin-development/choosing-jenkins-baseline.adoc

Bump Jenkins good core dependencies LTS version in the recommended versions section

1 file(s) updated with "${1}2.387.3 and 2.401.3${3}": * content/doc/developer/plugin-development/choosing-jenkins-baseline.adoc

Bump Jenkins latest LTS version in the recommended versions section

1 file(s) updated with "${1}2.414.2${3}": * content/doc/developer/plugin-development/choosing-jenkins-baseline.adoc

Bump Jenkins minimum BOM artifact version in the "dependency management" page

1 file(s) updated with "${1}2465.va_e76ed7b_3061${3}": * content/doc/developer/plugin-development/dependency-management.adoc

Bump Jenkins minimum LTS version in the "improve a plugin tutorial"

1 file(s) updated with "${1}2.401.3${3}": * content/doc/developer/tutorial-improve/update-base-jenkins-version.adoc

Bump Jenkins minimum LTS version in the "improve a plugin tutorial task"

1 file(s) updated with "${1}2.401.3${3}": * content/doc/developer/tutorial-improve/update-base-jenkins-version.adoc

Bump Jenkins minimum BOM artifact in the "dependency management" page

1 file(s) updated with "${1}bom-2.387.x${3}": * content/doc/developer/plugin-development/dependency-management.adoc


Updatecli logo

Created automatically by Updatecli

Options:

Most of Updatecli configuration is done via its manifest(s).

  • If you close this pull request, Updatecli will automatically reopen it, the next time it runs.
  • If you close this pull request and delete the base branch, Updatecli will automatically recreate it, erasing all previous commits made.

Feel free to report any issues at github.com/updatecli/updatecli.
If you find this tool useful, do not hesitate to star our GitHub repository as a sign of appreciation, and/or to tell us directly on our chat!

@probot-autolabeler probot-autolabeler bot added the documentation Jenkins documentation, including user and developer docs, solution pages, etc. label Sep 30, 2023
Copy link
Contributor

@dduportal dduportal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM for the shell script + updatecli part but I would want a second pair of eye from the docs reviewer on the changed adoc content

##############################################################
# BUMP LAST THREE JENKINS' LTS VERSIONS IN THE DOCUMENTATION #
##############################################################


SOURCES
=======

JenkinsThirdToLastLTSTruncated
------------------------------
The shell 🐚 command "/bin/sh /tmp/updatecli/bin/96dd80dd757bf4c3c92aa37c45dff38f9479a4992b3bffd471bf469d2ac888ab.sh" ran successfully with the following output:
----
2.387
----
✔ shell command executed successfully

JenkinsTooOldToSucceedLTSTruncated
----------------------------------
The shell 🐚 command "/bin/sh /tmp/updatecli/bin/c6fece53fbb73ec2d8efaccb406ae2e6ad7fcfdf8850457680f8e75fff4441d8.sh" ran successfully with the following output:
----
2.319
----
✔ shell command executed successfully

BOM
---
✔ Latest version is 2465.va_e76ed7b_3061 on the Maven repository at https://repo.jenkins-ci.org/releases/io/jenkins/tools/bom/bom-2.387.x/maven-metadata.xml
--- content/doc/developer/plugin-development/dependency-management.adoc
+++ content/doc/developer/plugin-development/dependency-management.adoc
@@ -90,7 +90,7 @@
     <dependencies>
         <dependency>
             <groupId>io.jenkins.tools.bom</groupId>
-            <artifactId>bom-2.375.x</artifactId>
+            <artifactId>bom-2.387.x</artifactId>
             <!-- Latest version goes here -->
             <version>1981.v17df70e84a_a_1</version>
             <scope>import</scope>

```

⚠ - 1 file(s) updated with "${1}bom-2.387.x${3}":
	* content/doc/developer/plugin-development/dependency-management.adoc

setLTSVersionAsATask
--------------------

**Dry Run enabled**

"content/doc/developer/tutorial-improve/update-base-jenkins-version.adoc" updated with [dry run] content "${1}2.401.3${3}"

```
--- content/doc/developer/tutorial-improve/update-base-jenkins-version.adoc
+++ content/doc/developer/tutorial-improve/update-base-jenkins-version.adoc
@@ -5,7 +5,7 @@
 
 :modified-files: pom.xml
 :task-identifier: require-newer-core
-:task-description: Require PLACEHOLDER_RECENT_LTS_POINT_HIGH as minimum Jenkins version
+:task-description: Require 2.401.3 as minimum Jenkins version
 
 = Update minimum Jenkins version
 

```

⚠ - 1 file(s) updated with "${1}2.401.3${3}":
	* content/doc/developer/tutorial-improve/update-base-jenkins-version.adoc

setSuperOldBOMBaseVersionInUpdateMinimumRequiredJenkinsVersion
--------------------------------------------------------------

**Dry Run enabled**

✔ - all contents from 'file' and 'files' combined already up to date

setJenkinsLatestLTSVersionInRecommendedVersions
-----------------------------------------------

**Dry Run enabled**

"content/doc/developer/plugin-development/choosing-jenkins-baseline.adoc" updated with [dry run] content "${1}2.414.2${3}"

```
--- content/doc/developer/plugin-development/choosing-jenkins-baseline.adoc
+++ content/doc/developer/plugin-development/choosing-jenkins-baseline.adoc
@@ -38,7 +38,7 @@
 ## Currently recommended versions
 
 At the moment, the Jenkins releases *PLACEHOLDER_RECENT_LTS_POINT_HIGHS* make good core dependencies.
-You could also consider *PLACEHOLDER_NEWER_LTS_POINT_ONE* if there are specific reasons, like new features, to want something newer.
+You could also consider *2.414.2* if there are specific reasons, like new features, to want something newer.
 
 ## Changing the minimum required version
 

```

⚠ - 1 file(s) updated with "${1}2.414.2${3}":
	* content/doc/developer/plugin-development/choosing-jenkins-baseline.adoc

setBOMVersionInDependencyManagement
-----------------------------------

**Dry Run enabled**

"content/doc/developer/plugin-development/dependency-management.adoc" updated with [dry run] content "${1}2465.va_e76ed7b_3061${3}"

```
--- content/doc/developer/plugin-development/dependency-management.adoc
+++ content/doc/developer/plugin-development/dependency-management.adoc
@@ -92,7 +92,7 @@
             <groupId>io.jenkins.tools.bom</groupId>
             <artifactId>bom-2.375.x</artifactId>
             <!-- Latest version goes here -->
-            <version>1981.v17df70e84a_a_1</version>
+            <version>2465.va_e76ed7b_3061</version>
             <scope>import</scope>
             <type>pom</type>
         </dependency>

```

⚠ - 1 file(s) updated with "${1}2465.va_e76ed7b_3061${3}":
	* content/doc/developer/plugin-development/dependency-management.adoc


ACTIONS
========

[Dry Run] An action of kind "github/pullrequest" is expected.

Copy link
Member

@NotMyFault NotMyFault left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pages look much better now, thanks!

@dduportal
Copy link
Contributor

Let's roll: we are 2 maintainers whom approved.

@dduportal dduportal merged commit a81cf8b into jenkins-infra:master Oct 5, 2023
9 checks passed
abhishekmaity added a commit to abhishekmaity/jenkins.io that referenced this pull request Oct 9, 2023
* script update for prototype js removal (jenkins-infra#6730)

* script update for prototype js removal

* script update for prototype js removal

* Update content/blog/2023/05/12/2023-05-12-removing-prototype-from-jenkins.adoc

Co-authored-by: Zbynek Konecny <zbynek1729@gmail.com>

---------

Co-authored-by: Zbynek Konecny <zbynek1729@gmail.com>

* Update dependency bootstrap to v5.3.2 (jenkins-infra#6727)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* Automated changelog for 2.426 (jenkins-infra#6707)

* Automated changelog for 2.426

* Edits to fix layout

* Link to JEP-237

* Add docker container entry to 2.426 changelog

* Fix 2.426 release date

---------

Co-authored-by: jenkins-infra-changelog-generator <86592549+jenkins-infra-changelog-generator[bot]@users.noreply.github.com>
Co-authored-by: Mark Waite <mark.earl.waite@gmail.com>

* [JEP-237] Introduce initial documentation for FIPS-140 (jenkins-infra#6675)

* [JEP-237] Introduce initial administration documentation for FIPS-140

Add user facing documentation for https://github.com/jenkinsci/jep/blob/master/jep/237/README.adoc

* [JEP-237] Introduce initial developer documentaion for FIPS-130

Adds developer facing documentation to allow them to better understand
what constitutes compliant vs non compliant code.

* Apply suggestions from code review

Co-authored-by: Anita Manders <98364016+ammanders@users.noreply.github.com>
Co-authored-by: Raúl Arabaolaza Barquin <rarabaolaza@cloudbees.com>

* [JEP-237] add example and document KeyStore

* Apply suggestions from code review

Co-authored-by: Julie Heard <55280278+julieheard@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Anita Manders <98364016+ammanders@users.noreply.github.com>

* fix indentation

* add admonition

* tweaks and s/FIPS/FIPS-140/

* rework note on using libraries

* Fix admonition

* fix link to system property

* update some more links

* Apply suggestions from Mark Waite

Co-authored-by: Mark Waite <mark.earl.waite@gmail.com>

* Add level 1 heading that I mistakenly suggested for removal

* Remove trailing blank from new content

* Removing trailing blank from new content

---------

Co-authored-by: Anita Manders <98364016+ammanders@users.noreply.github.com>
Co-authored-by: Raúl Arabaolaza Barquin <rarabaolaza@cloudbees.com>
Co-authored-by: Julie Heard <55280278+julieheard@users.noreply.github.com>
Co-authored-by: Kevin Martens <99040580+kmartens27@users.noreply.github.com>
Co-authored-by: Mark Waite <mark.earl.waite@gmail.com>

* [Python Tutorial] Bump Python alpine docker image version to 3.12.0-alpine3.18 (jenkins-infra#6733)

* chore: Update the value of the python docker image for pipelines in t...

... he 'Hello World!' tutorial

Made with ❤️️ by updatecli

* chore: Update the value of the python docker image for scripts in the...

...  'build-a-python-app-with-pyinstaller.adoc' tutorial

Made with ❤️️ by updatecli

* chore: Update the value of the python docker image for scripts in the...

...  'Hello World!' tutorial

Made with ❤️️ by updatecli

---------

Co-authored-by: GitHub Actions <41898282+github-actions[bot]@users.noreply.github.com>

* Update dependency faraday to v2.7.11 (jenkins-infra#6734)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* Update dependency rss to v0.3.0 (jenkins-infra#6737)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* Update dependency crate-ci/typos to v1.16.17 (jenkins-infra#6738)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* Update jenkinsciinfra/builder Docker tag to v2.2.68 (jenkins-infra#6735)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* feat(dependencies): Tracks Jenkins' three last LTS versions. (jenkins-infra#6717)

* feat(scripts): Gets the last three LTS releases.

* feat(scripts): Gets the last three LTS releases.

* fix(scripts): Comments

* feat(dependencies): Tracks and updates last three Jenkins LTS versions.

* feat(dependencies): Tracks and updates last three Jenkins LTS versions.

* feat(dependencies): Tracks last 3 Jenkins' LTS releases.

* fix(dependencies): Messages are now more accurate.

* fix(dependencies): Posix, mi amor.

* fix(dependencies): Posix, mon amour.

* fix(dependencies): No need to "x" the script anymore.

* fix(dependencies): Removed core-baseline

* fix(dependencies): Removes the core-baseline layout.

* Update choosing-jenkins-baseline.adoc

* Update update-base-jenkins-version.adoc

---------

Co-authored-by: Kevin Martens <99040580+kmartens27@users.noreply.github.com>

* Update jenkinsciinfra/builder Docker tag to v3 (jenkins-infra#6740)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* Bump Jenkins LTS versions to 2.414.2 in various parts of the documentation (jenkins-infra#6744)

* chore: Bump Jenkins minimum BOM artifact version in the "dependency m...

... anagement" page

Made with ❤️️ by updatecli

* chore: Bump Jenkins minimum BOM artifact in the "plugin-bill-of-mater...

... ials" page

Made with ❤️️ by updatecli

* chore: Bump Jenkins minimum BOM artifact version in the "plugin-bill-...

... of-materials" page

Made with ❤️️ by updatecli

* chore: Bump Jenkins minimum BOM artifact in the "dependency managemen...

... t" page

Made with ❤️️ by updatecli

---------

Co-authored-by: GitHub Actions <41898282+github-actions[bot]@users.noreply.github.com>

* Update node.js from 18.x to 20.x (jenkins-infra#6741)

* Add redirect for `hudson.model.UsageStatistics.disabled` property (jenkins-infra#6745)

Co-authored-by: Daniel Beck <daniel-beck@users.noreply.github.com>

* [Hello World Tutorial] Bump Golang alpine docker image version to 1.21.2-alpine3.18 (jenkins-infra#6746)

chore: Update the value of the golang docker image for pipelines in t...

... he 'Hello World!' tutorial

Made with ❤️️ by updatecli

Co-authored-by: GitHub Actions <41898282+github-actions[bot]@users.noreply.github.com>

* Remove link to private topic in community (jenkins-infra#6748)

Remove link to private community thread

The organizers of the 2021 Hacktoberfest project to localize in French
are not participating in HAcktoberfest 2023 in Jenkins.  The thread in
community.jenkins.io was made private at the end of the 2021 effort.

The remaining links are useful and the French localization effort is
still a good effort to continue.

* Restore placeholder calculation for version selection page (jenkins-infra#6751)

Calculate placeholders in the baseline selection file

Removing the placeholder processing left placeholder text.

Fixes jenkins-infra#6748

* Bump Jenkins LTS versions to 2.414.2 in various parts of the documentation (jenkins-infra#6750)

* chore: Bump Jenkins minimum BOM artifact version in the "plugin-bill-...

... of-materials" page

Made with ❤️️ by updatecli

* chore: Bump Jenkins minimum BOM artifact version in the "dependency m...

... anagement" page

Made with ❤️️ by updatecli

* chore: Bump Jenkins minimum BOM artifact version in the "improve a pl...

... ugin tutorial"

Made with ❤️️ by updatecli

---------

Co-authored-by: GitHub Actions <41898282+github-actions[bot]@users.noreply.github.com>

* fix(documentation): corebaseline is also used for other versions than LTS. (jenkins-infra#6752)

We have to keep it until we address the other uses.

* Add "Prototype removed" blog post (jenkins-infra#6742)

* Add "Prototype removed" blog post

* Update publication date

---------

Co-authored-by: Mark Waite <mark.earl.waite@gmail.com>

---------

Co-authored-by: Dmitry Platonov <47667812+Pldi23@users.noreply.github.com>
Co-authored-by: Zbynek Konecny <zbynek1729@gmail.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: jenkins-infra-changelog-generator[bot] <86592549+jenkins-infra-changelog-generator[bot]@users.noreply.github.com>
Co-authored-by: Mark Waite <mark.earl.waite@gmail.com>
Co-authored-by: James Nord <jtnord@users.noreply.github.com>
Co-authored-by: Anita Manders <98364016+ammanders@users.noreply.github.com>
Co-authored-by: Raúl Arabaolaza Barquin <rarabaolaza@cloudbees.com>
Co-authored-by: Julie Heard <55280278+julieheard@users.noreply.github.com>
Co-authored-by: Kevin Martens <99040580+kmartens27@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Bruno Verachten <gounthar@gmail.com>
Co-authored-by: Alexander Brandes <mc.cache@web.de>
Co-authored-by: Daniel Beck <1831569+daniel-beck@users.noreply.github.com>
Co-authored-by: Daniel Beck <daniel-beck@users.noreply.github.com>
Co-authored-by: Basil Crow <me@basilcrow.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore documentation Jenkins documentation, including user and developer docs, solution pages, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants