The main class of the Pipeline Steps Documentation Generator codebase contains some functions that are required exclusively for generating declarative steps documentation. Thus, it makes sense to move these functions to a new class that is dedicated to declarative steps.
There are two benefits of doing this:
- The main class becomes less crowded with specific use-case functions and variables making it more readable.
- All related functions are shifted to another class, making it easier to remove the generation of the declarative steps if the need arises.
Originally reported by vihaanthora, imported from: Separate declarative steps generation from main class
- assignee: vihaanthora
- status: Closed
- priority: Major
- component(s): workflow-cps-plugin
- label(s): declarative-pipeline, steps
- resolution: Fixed
- resolved: 2022-06-28T05:55:27+00:00
- votes: 0
- watchers: 1
- imported: 2025-12-07
Raw content of original issue
The main class of the Pipeline Steps Documentation Generator codebase contains some functions that are required exclusively for generating declarative steps documentation. Thus, it makes sense to move these functions to a new class that is dedicated to declarative steps.
There are two benefits of doing this:
- The main class becomes less crowded with specific use-case functions and variables making it more readable.
- All related functions are shifted to another class, making it easier to remove the generation of the declarative steps if the need arises.
The main class of the Pipeline Steps Documentation Generator codebase contains some functions that are required exclusively for generating declarative steps documentation. Thus, it makes sense to move these functions to a new class that is dedicated to declarative steps.
There are two benefits of doing this:
Originally reported by vihaanthora, imported from: Separate declarative steps generation from main class
Raw content of original issue