You are viewing a plain text version of this content. The canonical link for it is here.
Posted to npanday-commits@incubator.apache.org by "John R. Fallows (JIRA)" <ji...@apache.org> on 2011/04/13 05:01:05 UTC

[jira] [Created] (NPANDAY-402) Add support to automatically attach comments.xml as a project artifact

Add support to automatically attach comments.xml as a project artifact
----------------------------------------------------------------------

                 Key: NPANDAY-402
                 URL: https://issues.apache.org/jira/browse/NPANDAY-402
             Project: NPanday
          Issue Type: Improvement
          Components: Maven Plugins
    Affects Versions: 1.3.1-incubating
         Environment: $ mvn -v
Apache Maven 2.2.1 (rdebian-4)
Java version: 1.6.0_24
Java home: /usr/lib/jvm/java-6-sun-1.6.0.24/jre
Default locale: en_US, platform encoding: UTF-8
OS name: "linux" version: "2.6.35-28-generic" arch: "amd64" Family: "unix"

            Reporter: John R. Fallows
            Priority: Minor


The comments.xml file generated during CSharp compilation needs to be shipped to developers for use in Visual Studio, similar to the javadoc artifact produced by Maven for Java projects.

This is not currently attached as an artifact during the NPanday build for dotnet-library.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (NPANDAY-402) Add support to automatically attach comments.xml as a project artifact

Posted by "Lars Corneliussen (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/NPANDAY-402?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13019220#comment-13019220 ] 

Lars Corneliussen commented on NPANDAY-402:
-------------------------------------------

hi. this is good feedback.

You can now use the buildhelper attach-artifact plus the dotnet-vsdocs-type

For resolving it you have to add extra dependencies.
do you have an idea on how to automate the resolving part, too? pom rewrite?

The same is for PDBs and satelite assemblies (not yet supported). 



> Add support to automatically attach comments.xml as a project artifact
> ----------------------------------------------------------------------
>
>                 Key: NPANDAY-402
>                 URL: https://issues.apache.org/jira/browse/NPANDAY-402
>             Project: NPanday
>          Issue Type: Improvement
>          Components: Maven Plugins
>    Affects Versions: 1.3.1-incubating
>         Environment: $ mvn -v
> Apache Maven 2.2.1 (rdebian-4)
> Java version: 1.6.0_24
> Java home: /usr/lib/jvm/java-6-sun-1.6.0.24/jre
> Default locale: en_US, platform encoding: UTF-8
> OS name: "linux" version: "2.6.35-28-generic" arch: "amd64" Family: "unix"
>            Reporter: John R. Fallows
>            Priority: Minor
>
> The comments.xml file generated during CSharp compilation needs to be shipped to developers for use in Visual Studio, similar to the javadoc artifact produced by Maven for Java projects.
> This is not currently attached as an artifact during the NPanday build for dotnet-library.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Updated] (NPANDAY-402) Add support to automatically attach comments.xml as a project artifact

Posted by "Brett Porter (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/NPANDAY-402?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Brett Porter updated NPANDAY-402:
---------------------------------

    Fix Version/s: Backlog

> Add support to automatically attach comments.xml as a project artifact
> ----------------------------------------------------------------------
>
>                 Key: NPANDAY-402
>                 URL: https://issues.apache.org/jira/browse/NPANDAY-402
>             Project: NPanday
>          Issue Type: Improvement
>          Components: Maven Plugins
>    Affects Versions: 1.4-incubating
>         Environment: $ mvn -v
> Apache Maven 2.2.1 (rdebian-4)
> Java version: 1.6.0_24
> Java home: /usr/lib/jvm/java-6-sun-1.6.0.24/jre
> Default locale: en_US, platform encoding: UTF-8
> OS name: "linux" version: "2.6.35-28-generic" arch: "amd64" Family: "unix"
>            Reporter: John R. Fallows
>            Priority: Minor
>             Fix For: Backlog
>
>
> The comments.xml file generated during CSharp compilation needs to be shipped to developers for use in Visual Studio, similar to the javadoc artifact produced by Maven for Java projects.
> This is not currently attached as an artifact during the NPanday build for dotnet-library.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (NPANDAY-402) Add support to automatically attach comments.xml as a project artifact

Posted by "John R. Fallows (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/NPANDAY-402?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13020472#comment-13020472 ] 

John R. Fallows commented on NPANDAY-402:
-----------------------------------------

IIRC, the buildhelper internally uses a MavenProject API to attach the referenced file to the project artifacts so they are automatically included during install and deploy.  The syntax for this is quite verbose, and relies on internal knowledge of the location of the generated target/comments.xml.

How about having an npanday plugin goal for this, such as:

  maven-compile-plugin:attach-vsdocs
    o comments = ${outputDirectory}/comments.xml
    o classifier = vsdocs

This would be automatically bound to the "package" phase.

Note that making it part of the compile plugin might combine nicely when a custom filename or location is used for the comments, keeping both goals in sync.

The maven-compile-plugin:attach-vsdocs goal would be bound to the various dotnet-* lifecycle definitions in the "package" phase, possibly only during the release process, same as javadocs.

The same strategy could be used for a similar, maven-compile-plugin:attach-pdb goal, noting that the filename ends with .mdb on Mono - not sure if the contents of these two file types are compatible or platform specific.

> Add support to automatically attach comments.xml as a project artifact
> ----------------------------------------------------------------------
>
>                 Key: NPANDAY-402
>                 URL: https://issues.apache.org/jira/browse/NPANDAY-402
>             Project: NPanday
>          Issue Type: Improvement
>          Components: Maven Plugins
>    Affects Versions: 1.3.1-incubating
>         Environment: $ mvn -v
> Apache Maven 2.2.1 (rdebian-4)
> Java version: 1.6.0_24
> Java home: /usr/lib/jvm/java-6-sun-1.6.0.24/jre
> Default locale: en_US, platform encoding: UTF-8
> OS name: "linux" version: "2.6.35-28-generic" arch: "amd64" Family: "unix"
>            Reporter: John R. Fallows
>            Priority: Minor
>
> The comments.xml file generated during CSharp compilation needs to be shipped to developers for use in Visual Studio, similar to the javadoc artifact produced by Maven for Java projects.
> This is not currently attached as an artifact during the NPanday build for dotnet-library.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira