feat: allow for custamizable detailsURL in withChecks#329
Open
esatterwhite wants to merge 1 commit into
Open
Conversation
693c36c to
bbeefef
Compare
timja
reviewed
May 21, 2026
Member
timja
left a comment
There was a problem hiding this comment.
not tested fully end 2 end but I've checked the UI and it looks fine.
Few minor comments.
| * @return a custom destination URL template string or empty string to use the default | ||
| */ | ||
| public String getCustomDetailsUrl(final Job<?, ?> job) { | ||
| return StringUtils.EMPTY; |
Member
There was a problem hiding this comment.
don't use the empty string, just return null I think
Author
There was a problem hiding this comment.
@timja
Should defaultURL default to null everywhere? I think I'm defaulting it to an empty string
2115c99 to
8f759f8
Compare
When using the withChecks wrapper the details url always points to the jenkins ui for the build. in cases where jenkins is behind a comany firewall or other network boundaries, this can be a bit frustrating for people outside the firewall on public facing repositories. Having the details url point to something that is accessible is very useful, but it is only possible with publishChecks. This aims to add the same functionality through the withChecks step. Resolves: jenkinsci#328
8f759f8 to
8183f2d
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
When using the withChecks wrapper the details url always points to the jenkins ui for the build. in cases where jenkins is behind a comany firewall or other network boundaries, this can be a bit frustrating for people outside the firewall on public facing repositories. Having the details url point to something that is accessible is very useful, but it is only possible with publishChecks.
This aims to add the same functionality through the withChecks step.
Resolves: #328
Testing done
pipeline { agent any stages { stage('Hello') { steps { withChecks( name: 'test', detailsURL: 'http://codedependant.net' ) { echo 'Hello World' echo 'ls -alh' } } } } }Reference build: https://github.com/esatterwhite/jenkins-checks-test/pull/1/checks?check_run_id=77236702409
It also still works with the original function signature syntax
Reference build: https://github.com/esatterwhite/jenkins-checks-test/pull/2/checks?check_run_id=77240137433
Submitter checklist