Markdown Params Plugin

[jesusnoseq]

Repository URL

https://github.com/jesusnoseq/markdown-params-plugin

New Repository Name

markdown-params-plugin

Description

Parse Markdown and extract params from lists.

It provides functions to parse markdown strings in order to search list of items, checkboxes included, preceded by headers.
In this way, for example, you could write in markdown a list of checkboxes and use them in a pipeline

GitHub users to have commit permission

@jesusnoseq

Jenkins project users to have release permission

jesusnoseq

Issue tracker

GitHub issues

[github-actions]

Hello from your friendly Jenkins Hosting Checker

It appears you have some issues with your hosting request. Please see the list below and correct all issues marked Required. Your hosting request will not be approved until these issues are corrected. Issues marked with Warning or Info are just recommendations and will not stall the hosting process.

• ⛔ Required: Your baseline specified does not meet the minimum Jenkins version required, please update <jenkins.version>2.414.3</jenkins.version> to at least 2.426.3 in your pom.xml. Take a look at the baseline recommendations.

You can re-trigger a check by editing your hosting request or by commenting /hosting re-check

[jenkins-cert-app]

Security audit, information and commands

The security team is auditing all the hosting requests, to ensure a better security by default.

This message informs you that a Jenkins Security Scan was triggered on your repository.
It takes ~10 minutes to complete.

Commands

The bot will parse all comments, and it will check if any line start with a command.

Security team only:

• /audit-ok => the audit is complete, the hosting can continue 🎉.
• /audit-skip => the audit is not necessary, the hosting can continue 🎉.
• /audit-findings => the audit reveals some issues that require corrections ✏️.

Anyone:

• /request-security-scan => the findings from the Jenkins Security Scan were corrected, this command will re-scan your repository 🔍.
• /audit-review => the findings from the audit were corrected, this command will ping the security team to review the findings 👀. It's only applicable when the previous audit required changes.

Only one command can be requested per comment.

(automatically generated message, version: 1.28.4)

[jenkins-cert-app]

The Jenkins Security Scan did not find anything dangerous with your plugin, congratulations! 🎉

---

💡 The Security team recommends that you are setting up the scan in your repository by following our guide.

[jesusnoseq]

/hosting re-check

[github-actions]

Hello from your friendly Jenkins Hosting Checker

It looks like you have everything in order for your hosting request. A member of the Jenkins hosting team will check over things that I am not able to check(code review, README content, etc) and process the request as quickly as possible. Thank you for your patience.

Hosting team members can host this request with /hosting host

[jesusnoseq]

/hosting re-check

[github-actions]

Hello from your friendly Jenkins Hosting Checker

It looks like you have everything in order for your hosting request. A member of the Jenkins hosting team will check over things that I am not able to check(code review, README content, etc) and process the request as quickly as possible. Thank you for your patience.

Hosting team members can host this request with /hosting host

[alecharp]

Hello @jesusnoseq, please see my following comments about the current state of the plugin configuration

• https://github.com/jesusnoseq/markdown-params-plugin/blob/main/pom.xml#L90-L113
  • you shouldn't need to declare those dependencies.
• you should be able to remove the version declaration for plugin dependencies
  • https://github.com/jesusnoseq/markdown-params-plugin/blob/b2944c940ee378b3edc872682cf0bb1cc9746da1/pom.xml#L127
  • https://github.com/jesusnoseq/markdown-params-plugin/blob/b2944c940ee378b3edc872682cf0bb1cc9746da1/pom.xml#L87
  • https://github.com/jesusnoseq/markdown-params-plugin/blob/b2944c940ee378b3edc872682cf0bb1cc9746da1/pom.xml#L81
• Commons Codec and Commons IO dependencies could be problematic as they are already provided by Jenkins Core with different version (for Commons Codec)
  • https://github.com/jesusnoseq/markdown-params-plugin/blob/b2944c940ee378b3edc872682cf0bb1cc9746da1/pom.xml#L66-L77
  • https://github.com/jenkinsci/jenkins/blob/35e8562d56de9195a3f62a904da73b6ad83fd0d1/bom/pom.xml#L113-L117
  • https://github.com/jenkinsci/jenkins/blob/35e8562d56de9195a3f62a904da73b6ad83fd0d1/bom/pom.xml#L123-L127
• please don't force the JVM version to 16 (https://github.com/jesusnoseq/markdown-params-plugin/blob/b2944c940ee378b3edc872682cf0bb1cc9746da1/pom.xml#L161-L164) as Jenkins is still requiring JVM 11 as the minimum version. Unless you are using a JDK syntax / feature which is only available in Java 16, I'd recommend to stick to Java 11 for now and in a few month you'll be able to move to Java 17 (lts version)

I'm not sure I see the use case for this plugin and the README is not really helping me to see, as the markdown string to be parsed is a static value. Could you please elaborate how you use this plugin?

[jesusnoseq]

Hello @alecharp 
Thanks for all the feedback.

I have fixed the dependency issues.
About how to use the plugin, I have made a diagram outlining the steps to use the plugin. I hope that helps.