Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Deprecate CheckMethod#toCheckUrl#26638

Merged
MarkEWaite merged 1 commit into
jenkinsci:masterfrom
daniel-beck:deprecate-toCheckUrl
Apr 17, 2026
Merged

Deprecate CheckMethod#toCheckUrl#26638
MarkEWaite merged 1 commit into
jenkinsci:masterfrom
daniel-beck:deprecate-toCheckUrl

Conversation

@daniel-beck
Copy link
Copy Markdown
Member

@daniel-beck daniel-beck commented Apr 14, 2026

This method generates a JS expression, which doesn't work with CSP enabled, so deprecate it.

Testing done

None

Screenshots (UI changes only)

Before

After

Proposed changelog entries

  • Deprecate CheckMethod#toCheckUrl method, which generates a JS expression, and does not work with CSP enabled.

Proposed changelog category

/label developer

Proposed upgrade guidelines

N/A

Submitter checklist

  • The 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.
  • UI changes do not introduce regressions when enforcing the current default rules of Content Security Policy Plugin. In particular, 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

@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).
  • If it would make sense to backport the change to LTS, be a Bug or Improvement, and either the issue or pull request must be labeled as lts-candidate to be considered.

Copilot AI review requested due to automatic review settings April 14, 2026 08:51
@comment-ops-bot comment-ops-bot Bot added the developer Changes which impact plugin developers label Apr 14, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Deprecates FormValidation.CheckMethod#toCheckUrl, which produces a JavaScript expression that is incompatible with CSP-enabled setups, nudging consumers toward CSP-safe alternatives.

Changes:

  • Add @deprecated Javadoc pointing to toStemUrl() and getDependsOn() as the replacement approach.
  • Annotate toCheckUrl() with @Deprecated.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

*
* @deprecated Use {@link #toStemUrl()} and {@link #getDependsOn()} instead.
*/
@Deprecated
Copy link

Copilot AI Apr 14, 2026

Choose a reason for hiding this comment

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

New deprecation is missing a since (and optionally forRemoval) value on the annotation/Javadoc. Jenkins core commonly uses @Deprecated(since = "<version>") (or forRemoval = true when appropriate), which makes it easier for API consumers and tooling to track when the deprecation started; consider updating this to match that pattern and include the version (or placeholder per release process).

Suggested change
@Deprecated
@Deprecated(since = "TODO")

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Contributor

@MarkEWaite MarkEWaite left a comment

Choose a reason for hiding this comment

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

This PR is now ready for merge. We will merge it after approximately 24 hours if there is no negative feedback. Please see the merge process documentation for more information about the merge process.

/label ready-for-merge

@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 Apr 15, 2026
@MarkEWaite MarkEWaite merged commit e9344f3 into jenkinsci:master Apr 17, 2026
21 of 22 checks passed
@daniel-beck daniel-beck deleted the deprecate-toCheckUrl branch April 17, 2026 23:23
@krisstern krisstern added the rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted label Apr 19, 2026
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 rfe For changelog: Minor enhancement. use `major-rfe` for changes to be highlighted

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants