Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add markdown-formatter plugin to ci.jenkins.io #4030

Open
MarkEWaite opened this issue Apr 5, 2024 · 0 comments
Open

Add markdown-formatter plugin to ci.jenkins.io #4030

MarkEWaite opened this issue Apr 5, 2024 · 0 comments

Comments

@MarkEWaite
Copy link

MarkEWaite commented Apr 5, 2024

Service(s)

ci.jenkins.io

Summary

Allow markdown formatted job descriptions, comments, and Pipeline documentation on ci.jenkins.io so that we can include hyperlinks, lists, and more in job descriptions without inserting HTML markup

Reproduction steps

  1. Open the Pipeline syntax global variables page for our Pipeline library "buildDockerAndPublishImage" and see that the author of the description assumed that markdown is supported
  2. The hyperlinks and list on the root page of ci.jenkins.io are a little easier to manage in markdown than in HTML

We can allow markdown formatted descriptions by installing the markdown formatter plugin on ci.jenkins.io

Markdown support for the Pipeline case will need an upgraded Pipeline Groovy library plugin that includes the pull request from @mawinter69:

Before a new plugin like the markdown formatter is deployed on ci.jenkins.io, we've liked to have the Jenkins security team review the plugin to assure it is acceptable for a large scale installation like ci.jenkins.io. We need the core-security-review team to review the plugin for security issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants