[ 
https://issues.apache.org/jira/browse/NIFI-5859?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16715535#comment-16715535
 ] 

ASF GitHub Bot commented on NIFI-5859:
--------------------------------------

Github user bbende commented on a diff in the pull request:

    https://github.com/apache/nifi-maven/pull/7#discussion_r240308506
  
    --- Diff: src/main/java/org/apache/nifi/NarMojo.java ---
    @@ -426,12 +479,260 @@
         protected boolean cloneDuringInstanceClassLoading;
     
     
    +    /**
    +     * The {@link RepositorySystemSession} used for obtaining the local 
and remote artifact repositories.
    +     */
    +    @Parameter(defaultValue = "${repositorySystemSession}", readonly = 
true)
    +    private RepositorySystemSession repoSession;
    +
    +
    +    /**
    +     * The {@link ProjectBuilder} used to generate the {@link 
MavenProject} for the nar artifact the dependency tree is being generated for.
    +     */
    +    @Component
    +    private ProjectBuilder projectBuilder;
    +
    +
    +
         @Override
    -    public void execute() throws MojoExecutionException, 
MojoFailureException {
    +    public void execute() throws MojoExecutionException {
             copyDependencies();
    +
    +        try {
    +            generateDocumentation();
    --- End diff --
    
    Could we add an optional property like "enforceDocGeneration" (or some 
better name) that when true we would let the exception be thrown here to fail 
the build?
    
    The use-case would be to know that when doing a release we have 
successfully generated the docs if the build passed. Right now it can silently 
fail with a warning and you'd have to manually inspect every NAR to really know.


> Update NAR maven plugin to include information about Extensions
> ---------------------------------------------------------------
>
>                 Key: NIFI-5859
>                 URL: https://issues.apache.org/jira/browse/NIFI-5859
>             Project: Apache NiFi
>          Issue Type: New Feature
>          Components: Tools and Build
>            Reporter: Mark Payne
>            Assignee: Mark Payne
>            Priority: Major
>
> In order to have the NiFi Registry host any extensions, the registry will 
> need a way to know what extensions exist in a given NAR. Currently, that 
> information is not available directly.
> The NAR maven plugin should be updated to provide a list of extensions and 
> for each one, provide at least the following minimal information:
>  * Extension Type
>  * Extension Name
>  * Capability Description
>  * Whether or not the component is Restricted, "sub-restrictions" it has, and 
> explanations of both
>  * Any Tags that the component has
>  * If the component is a Controller Service, any Controller Service API's 
> that it provides
> Additionally, it would be ideal to provide all documentation for the 
> component within the NAR. It is best, though, not to write the documentation 
> in HTML as is done now but rather in XML or some sort of form that provides 
> the information in a structured way without any styling. This would allow the 
> documentation to be rendered consistently, even if the styling changes from 1 
> version to the next.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Reply via email to