Code changed in jenkins
User: Alex Taylor
Path:
COMPATIBILITY.md
http://jenkins-ci.org/commit/workflow-plugin/a52befc18cddcd153cf9468797bd1119e75c13b2
Log:
JENKINS-33458 Note Sidebar Link plugin

Sidebar link Plugin added to Compatibility.md

Code changed in jenkins
User: Jesse Glick
Path:
COMPATIBILITY.md
http://jenkins-ci.org/commit/workflow-plugin/c90a35dec2f8ac2fd5d52f5b1ca39b9a13e51571
Log:
Merge pull request #361 from alexanderrtaylor/master

JENKINS-33458 Note Sidebar Link plugin

Compare: https://github.com/jenkinsci/workflow-plugin/compare/1d45a6ea661f...c90a35dec2f8

The implementation seems pretty straightforward for this plugin, but I think the use case is unclear

The tasks to complete:

• Clarify use cases
• Refactor to use pipeline compatible APIs
• Add pipeline step to create sidebar links 
• Create tests that use step from pipeline
• Manually confirm that the plugin works

Questions about acceptance criteria:

• The current plugin adds a link to the project page, but do we want to add the option for each build to add a link to the build page? The use case could be adding a link to an externally published coverage report for a PR that you wouldn't want on the job page. 
• Should anyone be able to add/remove/edit sidebar links? (potential for PRs to spam) How are permissions handled?
  • Would have to decide how to identify sidebar links if multiple, either by url or link text
• Icon configuration; include filepath relative to workspace? set in the Job config? restrict to existing Jenkins link icons?

alexbrjo  Not quite, we just need to be able to add links to pipelines just like other projects. It doesn't need addition of a step here I think.

For presentation, please put the tasks up front, then the nodes/questions, for clarity, and include tests in the acceptance criteria.  I think for the first bullet under tasks, I'd say "clarify how use cases work."

In answer to questions:

> The current plugin adds a link to the project page, but do we want to add the option for each build to add a link to the build page

Out of scope for this story, that's a separate RFE - could talk about if we want to do that too though (as an extra item), after this, but that's a different discussion. 

> Should anyone be able to add/remove/edit sidebar links? (potential for PRs to spam) How are permissions handled?

Should be covered by permissions checks on the parent item (from Stapler).  If you suspect there's a vulnerability, double check it an it needs to be reported to the security team (see https://jenkins.io/security/) – as a member of that team, I can give you a quick readthrough though. 

> Icon configuration; include filepath relative to workspace? set in the Job config? restrict to existing Jenkins link icons?

AFAICT it's not using the workspace here, and we just need to support existing approaches.

Is there a pipeline script available to use with Sidebar Links plugin? by executing as pipeline script or by class wrapper?

I'm curious about this feature request - would it include the ability to add a sidebar link via Job DSL? I'm picturing something like:

properties( [addSidebarLink("Link Title", "/path/to/link/img", "http://link.url.including.${env.VARIABLES}")] )

A simple property that could be included in the Jenkinsfile would be very convenient for my team's use cases, and I can't seem to find the ability to do this elsewhere.

Proposed a PR: https://github.com/jenkinsci/sidebar-link-plugin/pull/9

Taking the absence of the lead maintainer, I am going to merge and release this pull request

Are there any updates to this issue? I'd love to see sidebar links back in Jenkins! Our use case is that a build generates data that is sent to Metabase which generates charts to query and visualize the test results.

It was released in 1.10.