Add DeclarativeDirective extension point for adding directives #260
Conversation
abayer
commented
Apr 4, 2018
abayer
commented
- JENKINS issue(s):
- n/a
- Description:
- New directives must provide a method for parsing from Jenkinsfile syntax, a JSON schema, a runtime model class, validation for the parsed AST model, and a method for transforming from the parsed AST model to the runtime model.
- Initially, will only provide support for preprocessing directives - which will provide a way to transform the full AST model after parsing and before validation and transformation. This will enable plugin authors to contribute directives that can be replaced by predetermined content before validation starts.
- Documentation changes:
- Actually, this makes me think that developer docs for all the Declarative extension points would be a good idea...
- Users/aliases to notify:
- ...
|
Note - this is a work-in-progress. I need to add tests and do some prototyping for a use case I have in mind to make sure this implementation will actually do the trick. I also need to decide if it's actually worth it to keep this as general as it is, or if it makes more sense to just provide a pre-processing directive extension point... |
abayer
force-pushed
the
directive-extension-point
branch
from
c785390 to
923591b
Compare
|
By just reading the title I fear this could lead to the "declarative model" getting out of hand if there is free reign for other plugins to add to the structure. |
abayer
force-pushed
the
directive-extension-point
branch
from
52e91f2 to
274a0c8
Compare
abayer
force-pushed
the
directive-extension-point
branch
from
a3902e3 to
1c75a07
Compare
rsandell
dismissed
their stale review
I only looked at the last commit and got confused
abayer
force-pushed
the
directive-extension-point
branch
2 times, most recently
from
f0c2e46 to
aefad28
Compare
New directives must provide a method for parsing from Jenkinsfile syntax, a JSON schema, a runtime model class, validation for the parsed AST model, and a method for transforming from the parsed AST model to the runtime model. Initially, will only provide support for preprocessing directives - which will provide a way to transform the full AST model after parsing and before validation and transformation. This will enable plugin authors to contribute directives that can be replaced by predetermined content before validation starts.
Useful for something that might want to extend ModelParser.
logging out of parsePipelineStep into new parseValidateAndTransformPipeline method.
abayer
force-pushed
the
directive-extension-point
branch
from
aefad28 to
c254c76
Compare
|
@abayer This seems like it could really use a JEP. |
rsandell
left a comment
rsandell
left a comment
There was a problem hiding this comment.
for being a new API the JavaDoc is lacking.
| private static Logger LOGGER = Logger.getLogger(DeclarativeDirectiveDescriptor.class.getName()); | ||
|
|
||
| @Nonnull | ||
| public abstract String getName(); |
There was a problem hiding this comment.
You seem to be using this in quite a lot of places that confuses me on the distinction between name and displayName.
But I can't come up with a better word for this either :)
|
@abayer Any chance you can resolve the merge conflicts here? Should this remain open? |
4 participants
