Usage/purpose of the "link" parameter is unclear

[kkaja123]

Describe your use-case which is not covered by existing documentation.

The "link" can be provided in the query or in the pipeline addEmbeddableBadgeConfiguration function. This results in the icon now being clickable, but I can't figure out how to embed the icon while still taking me to the configured link.

E.g. in Markdown, an image target hyperlink needs to be explicitly provided. It's not like the rendered markdown will automatically inherit the source icon's hyperlink target. I can make the markdown image's hyperlink the image itself, which takes me to a page that only has the badge, and I can click on that to go to the configured "link".

Maybe there's a special http://<jenkins_root>/buildStatus/link URL that would redirect the client to the configured "link", but I haven't been able to find anything in the documentation that could do something like that.

Ultimately, is there a point of the "link" parameter if the primary use case for the plugin is to "embed" the badges elsewhere, where the "link" parameter cannot be used? The information in the documentation about the "link" parameter is lacking in this regard.

Reference any relevant documentation, other materials or issues/pull requests that can be used for inspiration.

No response

Are you interested in contributing to the documentation?

No response

[MarkEWaite]

I think that I'm not understanding the question. The link parameter is primarily

I embed ci.jenkins.io build status in a GitHub markdown page to many ci.jenkins.io builds with the following markdown (one example)

[![Core](https://ci.jenkins.io/job/Core/job/jenkins/job/master/badge/icon?subject=Core)](https://ci.jenkins.io/job/Core/job/jenkins/job/master/)

The job status is provided by ci.jenkins.io from the https://ci.jenkins.io/job/Core/job/jenkins/job/master/badge/icon?subject=Core text. The hyperlink destination is provided by my Markdown https://ci.jenkins.io/job/Core/job/jenkins/job/master/

The ci.jenkins.io examples in the embeddable build status pages show that pattern as well.

I'm not aware of any way in markdown to embed an image and have that image also return its hyperlink destination.

Jenkins Pipeline

I use the link parameter to Pipeline so that when badges are added to a build, they have a link. Here is an example Pipeline:

pipeline {
    agent any
    stages {
        stage('Hello') {
            steps {
                echo 'Hello World'
                addInfoBadge id: 'info-badge-id', link: 'https://www.jenkins.io', text: 'Info Badge'
            }
        }
    }
}

[MarkEWaite]

Would it be clearer if the current "Query parameters" section of the documentation were split into two sections, one for badges inside Jenkins, and one for build status used outside of Jenkins?

The link argument to a badge definition works because it is processed inside Jenkins and the link value is converted into a clickable hyperlink inside Jenkins.

The link parameter in an HTML query string does not have any way of returning the link to the calling page.

[Tihana08]

Describe your use-case which is not covered by existing documentation.

The "link" can be provided in the query or in the pipeline addEmbeddableBadgeConfiguration function. This results in the icon now being clickable, but I can't figure out how to embed the icon while still taking me to the configured link.

E.g. in Markdown, an image target hyperlink needs to be explicitly provided. It's not like the rendered markdown will automatically inherit the source icon's hyperlink target. I can make the markdown image's hyperlink the image itself, which takes me to a page that only has the badge, and I can click on that to go to the configured "link".

Maybe there's a special http://<jenkins_root>/buildStatus/link URL that would redirect the client to the configured "link", but I haven't been able to find anything in the documentation that could do something like that.

Ultimately, is there a point of the "link" parameter if the primary use case for the plugin is to "embed" the badges elsewhere, where the "link" parameter cannot be used? The information in the documentation about the "link" parameter is lacking in this regard.

Reference any relevant documentation, other materials or issues/pull requests that can be used for inspiration.

No response

Are you interested in contributing to the documentation?

No response

[kkaja123]

To clarify, this doesn't relate to build badges like the ones added with addInfoBadge. I'm only concerned with the embeddable build status icon badges.

I'm pretty sure you are right that there isn't any way that the icon query can provide the calling page with a customized link.

Using your example for reference, would there be any reason to include the "link" query parameter in the markdown like this:

[![Core](https://ci.jenkins.io/job/Core/job/jenkins/job/master/badge/icon?subject=Core&link=google.com)](https://ci.jenkins.io/job/Core/job/jenkins/job/master/)

It's not like clicking the status badge would take you to Google. If there are any intended use cases for providing the "link" query parameter in embedded icons, then those should be documented as examples.

When adding the badge configuration from the Pipeline for the "Core" badge in the example, if the link is set to 'google.com', the only way to get to google is to first navigate to https://ci.jenkins.io/job/Core/job/jenkins/job/master/badge/icon?subject=Core, then clicking on the icon there will take you to google. But that technique can't be "embedded", since you have to go to the page where the plugin generates HTML to create a clickable icon.

That seems to indicate that the "link" parameter is only really useful if you are able to write a script that makes a web request to the icon page and embeds the response content into an HTML document or extracts the target link to create a new hyperlinked image. Such a use case isn't mentioned in the docs though.