[INFRA-1053] Generate Declarative directive docs. #12
Conversation
This is the first work in that direction - it may make sense to keep everything in here after all rather than splitting things up as in This generates (at least in theory) Asciidoc for the Declarative directives that contain Describables - i.e., `agent`, `when`, `options`, `triggers`, and `parameters`. More work is needed to special-case `post` due to its conditions not being Describables. Grr. I have regrets there.
|
Ok, I think the latest commit is doing what we want. I did a local run against that Declarative PR's artifacts to get |
| @@ -206,4 +224,106 @@ public void generateAscii(Map<String, Map<String, List<StepDescriptor>>> allStep | |||
| } | |||
| } | |||
| } | |||
|
|
|||
| public void generateDeclarativeAscii() { | |||
There was a problem hiding this comment.
Think this could be pulled out of this class? I hoped that PipelineStepExtractor would act more as a hub that goes about calling other classes to do the heavy lifting.
|
The printout looks nice. It'd be nice to point to the docs and I see you've got another PR to add the help steps; that'll be nice going in. |
| @@ -66,7 +66,7 @@ | |||
| <dependency> | |||
| <groupId>org.jenkins-ci.main</groupId> | |||
| <artifactId>jenkins-core</artifactId> | |||
| <version>1.651</version> | |||
| <version>2.7.1</version> | |||
There was a problem hiding this comment.
The biggest change... 😁
There was a problem hiding this comment.
Regrettably needed to get the Declarative dependency.
|
@kwhetstone And yeah, now I need to figure out how to integrate the docs into jenkins.io. Fun! |
|
Check fetch-external-resources -> that should pull in the pipeline steps to the website. |
INFRA-1053
This is the first work in that direction - it may make sense to keep
everything in here after all rather than splitting things up as in #11
This generates (at least in theory) Asciidoc for the Declarative
directives that contain Describables - i.e.,
agent,when,options,triggers, andparameters. More work is needed tospecial-case
postdue to its conditions not beingDescribables. Grr. I have regrets there.
Also, this depends on jenkinsci/pipeline-model-definition-plugin#219 to actually have help info for the Declarative-specific extension points.