Skip to content

Conversation

@das7pad
Copy link
Contributor

@das7pad das7pad commented Sep 15, 2025

This PR is adding an interface based constructor for AnnotatedLargeText. The workflow-api plugin will make use of it for implementing a streaming based step log (jenkinsci/workflow-api-plugin#438).

Testing done

The interface based constructor is tested in stapler and jenkinsci/workflow-api-plugin#438.

Proposed changelog entries

  • Add interface based constructor for AnnotatedLargeText.

Proposed changelog category

/remove-label work-in-progress

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). 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).
  • 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

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).
  • 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).

@comment-ops-bot comment-ops-bot bot added the work-in-progress The PR is under active development, not ready to the final review label Sep 15, 2025
@das7pad
Copy link
Contributor Author

das7pad commented Sep 15, 2025

/label developer

@comment-ops-bot comment-ops-bot bot added the developer Changes which impact plugin developers label Sep 15, 2025
@timja timja changed the title [DO NOT MERGE] Update stapler to pull in interface based constructor for LargeText Update stapler to pull in interface based constructor for LargeText Sep 16, 2025
@timja
Copy link
Member

timja commented Sep 16, 2025

(do not merge isn't needed if its a draft PR..)

@github-actions
Copy link
Contributor

Please take a moment and address the merge conflicts of your pull request. Thanks!

@github-actions github-actions bot added the unresolved-merge-conflict There is a merge conflict with the target branch. label Sep 17, 2025
@das7pad das7pad force-pushed the stapler-upgrade-large-text-interface branch from e7e6406 to 02f08b9 Compare October 3, 2025 09:36
@github-actions github-actions bot removed the unresolved-merge-conflict There is a merge conflict with the target branch. label Oct 3, 2025
@das7pad
Copy link
Contributor Author

das7pad commented Oct 4, 2025

@timja have you considered adding a "fast mode" for these kinds of PRs? Spending n times 5h of compute for getting an incremental build seems quite wasteful to me. Additionally you and I spent quite some time to get all the tests to pass here.

@MarkEWaite
Copy link
Contributor

@timja have you considered adding a "fast mode" for these kinds of PRs? Spending n times 5h of compute for getting an incremental build seems quite wasteful to me. Additionally you and I spent quite some time to get all the tests to pass here.

One way to reduce the time to generate an incremental build is to modify test/pom.xml in the pull request as follows:

diff --git a/test/pom.xml b/test/pom.xml
index 17ce252f89..3135694535 100644
--- a/test/pom.xml
+++ b/test/pom.xml
@@ -52,6 +52,8 @@ THE SOFTWARE.

     <!-- Filled in by maven-hpi-plugin with "-javaagent:/path/to/mockito-core-<version>.jar" -->
     <jenkins.javaAgent />
+
+    <test>hudson.AboutJenkinsTest</test>
   </properties>

   <dependencyManagement>

That is under the control of the developer submitting the pull request.

The other acceleration technique for incremental builds would require changes to the Jenkinsfile to disable the Windows build and disable the acceptance test harness. That is not under the control of the developer submitting the pull request unless they are already a maintainer of Jenkins core. An example of that technique is available at https://github.com/MarkEWaite/jenkins/tree/fast-incremental

@das7pad das7pad force-pushed the stapler-upgrade-large-text-interface branch from 35a14b4 to b9bec86 Compare October 4, 2025 11:41
@github-actions github-actions bot added the unresolved-merge-conflict There is a merge conflict with the target branch. label Oct 8, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Oct 8, 2025

Please take a moment and address the merge conflicts of your pull request. Thanks!

@github-actions github-actions bot removed the unresolved-merge-conflict There is a merge conflict with the target branch. label Oct 8, 2025
@timja timja changed the title Update stapler to pull in interface based constructor for LargeText Add new LargeText interface based constructor for AnnotatedLargeText Oct 8, 2025
@timja
Copy link
Member

timja commented Oct 8, 2025

@das7pad if this is ready could you update the description please

@das7pad
Copy link
Contributor Author

das7pad commented Oct 8, 2025

@das7pad if this is ready could you update the description please

Done. Thanks for removing the WIP changes and kicking off a build!

@das7pad das7pad marked this pull request as ready for review October 8, 2025 20:02
@comment-ops-bot comment-ops-bot bot removed the work-in-progress The PR is under active development, not ready to the final review label Oct 8, 2025
@timja timja requested a review from a team October 8, 2025 20:13
@timja
Copy link
Member

timja commented Oct 9, 2025

/label ready-for-merge


This PR is now ready for merge, after ~24 hours, we will merge it if there's no negative feedback.

Thanks!

@comment-ops-bot comment-ops-bot bot added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Oct 9, 2025
Copy link

@A1exKH A1exKH left a comment

Choose a reason for hiding this comment

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

LGTM.

@timja timja merged commit adacec0 into jenkinsci:master Oct 10, 2025
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

developer Changes which impact plugin developers ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants