jenkinsci / jenkinsci/support-core-plugin
[JENKINS-58341] Add a markdown library to write these files appropriately in support-core-plugin
- Dominant language
- Java
- Stars
- 19
- Forks
- 77
- Avg merge
- 17h 53m
- Merged PRs (30d)
- 3
Description
The plugin is writing some markdown plugins. So far, it's up to the developer to identify what pieces of data may have special characters and escape them with custom methods. There are a lot of texts not being escaped, for example:
- paths of files or directories with underscores
- labels with underscores
- etc
This ticket is to add a markdown library to write this type of files giving the responsibility of escaping the text to the library, therefore doing a better formatting.
I consider it a bug because currently there is a lot of unescaped texts that should be escaped.
---
Originally reported by
mramonleon, imported from: Add a markdown library to write these files appropriately in support-core-plugin
Raw content of original issue
The plugin is writing some markdown plugins. So far, it's up to the developer to identify what pieces of data may have special characters and escape them with custom methods. There are a lot of texts not being escaped, for example:
- paths of files or directories with underscores
- labels with underscores
- etc
This ticket is to add a markdown library to write this type of files giving the responsibility of escaping the text to the library, therefore doing a better formatting.
I consider it a bug because currently there is a lot of unescaped texts that should be escaped.
Contributor guide
Research direction
No files or tests are named. Start by locating the support-core-plugin code that writes Markdown files and the existing custom escaping methods. Identify the affected output paths and labels, then add focused coverage showing that special characters are escaped consistently through the selected library.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 32/100