Skip to content

Consistent Jelly version for commons-jelly-tags-fmt#10128

Merged
basil merged 1 commit into
jenkinsci:masterfrom
basil:jelly-fmt
Jan 7, 2025
Merged

Consistent Jelly version for commons-jelly-tags-fmt#10128
basil merged 1 commit into
jenkinsci:masterfrom
basil:jelly-fmt

Conversation

@basil

@basil basil commented Jan 7, 2025

Copy link
Copy Markdown
Member

We currently ship commons-jelly-tags-fmt 1.0 from 19 years ago. While the fact that it has not needed any changes in 19 years is a testament to the quality of that code, we were not so lucky in jenkinsci/jelly#110 and jenkinsci/json-lib@b1fe8a3, both of which required us to patch and deliver changes to unmaintained third-party libraries via our forks. We were able to do both easily because we had a pipeline for delivering changes, which we do not currently have for commons-jelly-tags-fmt because the project is dead upstream.

This PR solves this problem by switching our commons-jelly-tags-fmt JAR to the one built and deployed from our fork of Jelly. I compared the sources in our fork to that of https://repo1.maven.org/maven2/commons-jelly/commons-jelly-tags-fmt/1.0/commons-jelly-tags-fmt-1.0-sources.jar and, other than Javadoc updates for Java 11/17/21 compatibility, the sources were identical, so there is no risk here in terms of code change. The only difference in the JARs is that ours is now compiled with Java 17. More importantly, though, this allows us to deliver changes to this code in the future, should the need arise. Currently I do not anticipate such a need.

A similar problem exists for commons-jelly-tags-xml, which I am explicitly not tackling here. I could not easily find the source files for what we are shipping today in https://repo1.maven.org/maven2/commons-jelly/commons-jelly-tags-xml/1.1/ and it is not immediately obvious to me whether or not we are even using this functionality. Some more effort would be required (a) to confirm that we are using this functionality and (b) to dig up the source code for what we are shipping today (or decompile the JAR) to confirm that switching to the sources in our fork would not be introducing a regression.

Testing done

As mentioned above, confirmed that the only source code changes were changes to Javadoc comments, which carry a minimal to zero risk of regression. Automated testing should take care of the rest.

Jelly versions after this change:

WEB-INF/lib/commons-jelly-1.1-jenkins-20250107.jar
WEB-INF/lib/commons-jelly-tags-define-1.1-jenkins-20250107.jar
WEB-INF/lib/commons-jelly-tags-fmt-1.1-jenkins-20250107.jar
WEB-INF/lib/commons-jelly-tags-xml-1.1.jar (see note above)

Proposed changelog entries

N/A

Proposed upgrade guidelines

N/A

### Submitter checklist
- [ ] The Jira issue, if it exists, is well-described.
- [ ] The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood (see [examples](https://github.com/jenkins-infra/jenkins.io/blob/master/content/_data/changelogs/weekly.yml)). Fill in the **Proposed upgrade guidelines** section only if there are breaking changes or changes that may require extra steps from users during upgrade.
- [ ] There is automated testing or an explanation as to why this change has no tests.
- [ ] New public classes, fields, and methods are annotated with `@Restricted` or have `@since TODO` Javadocs, as appropriate.
- [ ] New deprecations are annotated with `@Deprecated(since = "TODO")` or `@Deprecated(forRemoval = true, since = "TODO")`, if applicable.
- [ ] New or substantially changed JavaScript is not defined inline and does not call `eval` to ease future introduction of Content Security Policy (CSP) directives (see [documentation](https://www.jenkins.io/doc/developer/security/csp/)).
- [ ] For dependency updates, there are links to external changelogs and, if possible, full differentials.
- [ ] For new APIs and extension points, there is a link to at least one consumer.

Desired reviewers

@mention

Before the changes are marked as ready-for-merge:

### Maintainer checklist
- [ ] There are at least two (2) approvals for the pull request and no outstanding requests for change.
- [ ] Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.
- [ ] Changelog entries in the pull request title and/or **Proposed changelog entries** are accurate, human-readable, and in the imperative mood.
- [ ] Proper changelog labels are set so that the changelog can be generated automatically.
- [ ] If the change needs additional upgrade steps from users, the `upgrade-guide-needed` label is set and there is a **Proposed upgrade guidelines** section in the pull request title (see [example](https://github.com/jenkinsci/jenkins/pull/4387)).
- [ ] If it would make sense to backport the change to LTS, a Jira issue must exist, be a _Bug_ or _Improvement_, and be labeled as `lts-candidate` to be considered (see [query](https://issues.jenkins.io/issues/?filter=12146)).

@basil basil added the skip-changelog Should not be shown in the changelog label Jan 7, 2025

@basil basil left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Merging this so that we can avoid unnecessary Renovate builds for these two dependencies and so that I can rebase other Stapler PRs on top of these changes.

@basil basil merged commit 84ac21f into jenkinsci:master Jan 7, 2025
@basil basil deleted the jelly-fmt branch January 7, 2025 19:17
MarkEWaite pushed a commit to MarkEWaite/jenkins that referenced this pull request Mar 17, 2025
gounthar pushed a commit to gounthar/jenkins that referenced this pull request Mar 17, 2025
MarkEWaite pushed a commit to MarkEWaite/jenkins that referenced this pull request Mar 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip-changelog Should not be shown in the changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants