jenkinsci / jenkinsci/workflow-cps-plugin

[JENKINS-35685] Auto-generate help for RunWrapperBinder/RunWrapper

Open
#1,194 1 comment 0 reactions 0 assignees View on GitHub
component:workflow-cps-plugin imported-jira-issue jira-type:task priority:minor resolution:unresolved
Dominant language
Java
Stars
186
Forks
213
Avg merge
12h 12m
Merged PRs (30d)
8

Description

RunWrapper has a lot more @​Whitelisted methods on it than are covered in the help doc - it'd be great if we could inspect Javadoc on those methods and spit out help from that automatically. Might even be something we could extend to other GlobalVariable use cases like Docker's - some sort of annotation on functions that lets us know to inspect them... jglick, thoughts?

---
Originally reported by abayer, imported from: Auto-generate help for RunWrapperBinder/RunWrapper


  • assignee: jglick
  • status: Open
  • priority: Minor
  • component(s): workflow-cps-plugin
  • resolution: Unresolved
  • votes: 0
  • watchers: 2
  • imported: 2025-12-07

Raw content of original issue

RunWrapper has a lot more @Whitelisted methods on it than are covered in the help doc - it'd be great if we could inspect Javadoc on those methods and spit out help from that automatically. Might even be something we could extend to other GlobalVariable use cases like Docker's - some sort of annotation on functions that lets us know to inspect them... jglick, thoughts?

Contributor guide

Open the contributing guide

Research direction

Start by locating RunWrapperBinder and RunWrapper, then review their @Whitelisted methods and available Javadoc. The issue also suggests GlobalVariable use cases such as Docker, but does not identify implementation files, tests, or a defined completion boundary; done would require an agreed approach that generates the missing help documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.