Done, thanks for the suggestion. 2015-01-02 12:45 GMT+01:00 sebb <seb...@gmail.com>:
> On 2 January 2015 at 09:18, <brit...@apache.org> wrote: > > Author: britter > > Date: Fri Jan 2 09:18:37 2015 > > New Revision: 1648982 > > > > URL: http://svn.apache.org/r1648982 > > Log: > > COMMONSSITE-81: commons-build-plugin README/CONTRIBUTING.md handle > multi-modules. Fix implemented by Bernd Eckenfels. > > > > Modified: > > commons/proper/commons-build-plugin/trunk/pom.xml > > commons/proper/commons-build-plugin/trunk/src/changes/changes.xml > > > > commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/ > contributing-md-template.md > > > > commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/ > readme-md-template.md > > > > commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml > > > > commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.mojos.xml > > > > Modified: commons/proper/commons-build-plugin/trunk/pom.xml > > URL: > http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/pom.xml?rev=1648982&r1=1648981&r2=1648982&view=diff > > > ============================================================================== > > --- commons/proper/commons-build-plugin/trunk/pom.xml (original) > > +++ commons/proper/commons-build-plugin/trunk/pom.xml Fri Jan 2 > 09:18:37 2015 > > @@ -44,8 +44,8 @@ > > <distributionManagement> > > <site> > > <id>apache.website</id> > > - <name>Apache Commons ${commons.componentid} Site</name> > > - <url>${commons.deployment.protocol}:// > people.apache.org/www/commons.apache.org/${commons.componentid}</url> > > + <name>Apache Commons commons-${commons.componentid} > Site</name> > > + <url>${commons.deployment.protocol}:// > people.apache.org/www/commons.apache.org/commons-${commons.componentid} > </url> > > </site> > > </distributionManagement> > > <developers> > > @@ -156,7 +156,7 @@ > > <maven.compiler.source /> > > <maven.compiler.target /> > > <commons.manifestfile /> > > - <commons.componentid>commons-build-plugin</commons.componentid> > > + <commons.componentid>build-plugin</commons.componentid> > > <commons.jira.id>COMMONSSITE</commons.jira.id> > > > <commons.jira.pid>12310466&amp;component=12312401</commons.jira.pid> > > > <commons.release.version>${project.version}</commons.release.version> > > > > Modified: > commons/proper/commons-build-plugin/trunk/src/changes/changes.xml > > URL: > http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/changes/changes.xml?rev=1648982&r1=1648981&r2=1648982&view=diff > > > ============================================================================== > > --- commons/proper/commons-build-plugin/trunk/src/changes/changes.xml > (original) > > +++ commons/proper/commons-build-plugin/trunk/src/changes/changes.xml > Fri Jan 2 09:18:37 2015 > > @@ -27,6 +27,9 @@ > > <body> > > > > <release version="1.5" date="TBD" description="TBD"> > > + <action dev="ecki" type="update" issue="COMMONSSITE-81"> > > + commons-build-plugin README/CONTRIBUTING.md handle multi-modules > > + </action> > > <action dev="ecki" type="update"> > > Download Page - Better describes KEYS file (and uses https > links). > > </action> > > > > Modified: > commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/ > contributing-md-template.md > > URL: > http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/contributing-md-template.md?rev=1648982&r1=1648981&r2=1648982&view=diff > > > ============================================================================== > > --- > commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/ > contributing-md-template.md (original) > > +++ > commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/ > contributing-md-template.md Fri Jan 2 09:18:37 2015 > > @@ -50,7 +50,7 @@ Getting Started > > > > + Make sure you have a [JIRA account](https://issues.apache.org/jira/). > > + Make sure you have a [GitHub account](https://github.com/signup/free > ). > > -+ If you're planning to implement a new feature it makes sense to > discuss you're changes on the [dev list]( > http://commons.apache.org/proper/@ARTIFACTID@/mail-lists.html) first. > This way you can make sure you're not wasting your time on something that > isn't considered to be in @NAME@'s scope. > > ++ If you're planning to implement a new feature it makes sense to > discuss you're changes on the [dev list]( > https://commons.apache.org/proper/commons-@ID@/mail-lists.html) first. > This way you can make sure you're not wasting your time on something that > isn't considered to be in @NAME@'s scope. > > We could just use > https://commons.apache.org/mail-lists.html > here > > > + Submit a ticket for your issue, assuming one does not already exist. > > + Clearly describe the issue including steps to reproduce when it is > a bug. > > + Make sure you fill in the earliest version that you know has the > issue. > > @@ -86,12 +86,12 @@ Submitting Changes > > Additional Resources > > -------------------- > > > > -+ [Contributing patches](http://commons.apache.org/patches.html) > > ++ [Contributing patches](https://commons.apache.org/patches.html) > > + [@NAME@ JIRA project page]( > https://issues.apache.org/jira/browse/@JIRA_ID@) > > + [Contributor License Agreement][cla] > > -+ [General GitHub documentation](http://help.github.com/) > > -+ [GitHub pull request documentation]( > http://help.github.com/send-pull-requests/) > > ++ [General GitHub documentation](https://help.github.com/) > > ++ [GitHub pull request documentation]( > https://help.github.com/send-pull-requests/) > > + [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) > > + #apachecommons IRC channel on freenode.org > > > > -[cla]:http://www.apache.org/licenses/#clas > > +[cla]:https://www.apache.org/licenses/#clas > > > > Modified: > commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/ > readme-md-template.md > > URL: > http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/readme-md-template.md?rev=1648982&r1=1648981&r2=1648982&view=diff > > > ============================================================================== > > --- > commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/ > readme-md-template.md (original) > > +++ > commons/proper/commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates/ > readme-md-template.md Fri Jan 2 09:18:37 2015 > > @@ -48,20 +48,20 @@ > > Documentation > > ------------- > > > > -More information can be found on the [homepage]( > http://commons.apache.org/proper/@ARTIFACTID@). > > -The [JavaDoc]( > http://commons.apache.org/proper/@ARTIFACTID@/javadocs/api-release) can > be browsed. > > +More information can be found on the [homepage]( > https://commons.apache.org/proper/commons-@ID@). > > +The [JavaDoc]( > https://commons.apache.org/proper/commons-@ID@/javadocs/api-release) can > be browsed. > > Questions related to the usage of @NAME@ should be posted to the [user > mailing list][ml]. > > > > Where can I get the latest release? > > ----------------------------------- > > -You can download source and binaries from our [download page]( > http://commons.apache.org/proper/@ARTIFACTID@/download_@ID@.cgi). > > +You can download source and binaries from our [download page]( > https://commons.apache.org/proper/commons-@ID@/download_@ID@.cgi). > > > > Alternatively you can pull it from the central Maven repositories: > > > > ```xml > > <dependency> > > <groupId>@GROUPID@</groupId> > > - <artifactId>@ARTIFACTID@</artifactId> > > + <artifactId>@ARTIFACTCOREID@</artifactId> > > <version>@VERSION@</version> > > </dependency> > > ``` > > @@ -76,23 +76,23 @@ There are some guidelines which will mak > > + Create minimal diffs - disable on save actions like reformat source > code or organize imports. If you feel the source code should be reformatted > create a separate PR for this change. > > + Provide JUnit tests for your changes and make sure your changes don't > break any existing tests by running ```mvn clean test```. > > > > -If you plan to contribute on a regular basis, please consider filing a > [contributor license agreement](http://www.apache.org/licenses/#clas). > > -You can learn more about contributing via GitHub in our [contribution > guidelines]( > https://github.com/apache/@ARTIFACTID@/blob/trunk/CONTRIBUTING.md). > > +If you plan to contribute on a regular basis, please consider filing a > [contributor license agreement](https://www.apache.org/licenses/#clas). > > +You can learn more about contributing via GitHub in our [contribution > guidelines]( > https://github.com/apache/commons-@ID@/blob/trunk/CONTRIBUTING.md). > > > > License > > ------- > > -Code is under the [Apache Licence v2]( > http://www.apache.org/licenses/LICENSE-2.0.txt). > > +Code is under the [Apache Licence v2]( > https://www.apache.org/licenses/LICENSE-2.0.txt). > > > > Donations > > --------- > > -You like @NAME@? Then [donate back to the ASF]( > http://www.apache.org/foundation/contributing.html) to support the > development. > > +You like @NAME@? Then [donate back to the ASF]( > https://www.apache.org/foundation/contributing.html) to support the > development. > > > > Additional Resources > > -------------------- > > > > -+ [Apache Commons Homepage](http://commons.apache.org/) > > ++ [Apache Commons Homepage](https://commons.apache.org/) > > + [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/) > > + [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) > > + #apachecommons IRC channel on freenode.org > > > > -[ml]:http://commons.apache.org/proper/@ARTIFACTID@/mail-lists.html > > +[ml]:https://commons.apache.org/proper/commons-@ID@/mail-lists.html > > Could just use: > > https://commons.apache.org/mail-lists.html > > > Modified: > commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml > > URL: > http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml?rev=1648982&r1=1648981&r2=1648982&view=diff > > > ============================================================================== > > --- > commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml > (original) > > +++ > commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.build.xml > Fri Jan 2 09:18:37 2015 > > @@ -321,15 +321,27 @@ > > </loadresource> > > <echo message="${readme-md}" file="${commonsMojoTempDir}/ > readme-md-template.md" append="false" /> > > > > + <!-- Without using ant-contrib: remove "-project" for > multi-module artifacts --> > > + <loadresource property="tmp.artifactId"> > > + <propertyresource name="project.artifactId" /> > > + <filterchain> > > + <tokenfilter> > > + <filetokenizer/> > > + <replacestring from="-project" to=""/> > > + </tokenfilter> > > + </filterchain> > > + </loadresource> > > + > > <!-- Copy the readme-md template filtering to replace > properties --> > > <copy file="${commonsMojoTempDir}/readme-md-template.md" > tofile="README.md" overwrite="true"> > > <filterset> > > - <filter token="NAME" value="${project.name}"/> > > - <filter token="ARTIFACTID" > value="${project.artifactId}"/> > > - <filter token="GROUPID" value="${project.groupId}"/> > > - <filter token="VERSION" > value="${commons.release.version}"/> > > - <filter token="DESCRIPTION" > value="${project.description}"/> > > - <filter token="ID" > value="${commons.componentid}"/> > > + <filter token="NAME" value="${project.name}"/> > > + <filter token="ARTIFACTID" > value="${project.artifactId}"/> > > + <filter token="ARTIFACTCOREID" value="${tmp.artifactId}"/> > > + <filter token="GROUPID" > value="${project.groupId}"/> > > + <filter token="VERSION" > value="${commons.release.version}"/> > > + <filter token="DESCRIPTION" > value="${project.description}"/> > > + <filter token="ID" > value="${commons.componentid}"/> > > </filterset> > > </copy> > > > > @@ -343,6 +355,7 @@ > > <echo level="${level}" message="project.name : ${ > project.name}" /> > > <echo level="${level}" message="project.artifactId : > ${project.artifactId}" /> > > <echo level="${level}" message="commons.jira.id : ${ > commons.jira.id}" /> > > + <echo level="${level}" message="commons.componentid : > ${commons.componentid}" /> > > <echo level="${level}" message="----- commons:readme-md - > Parameters - END -----" /> > > > > <echo level="info" message="*** Generating ${project.name} > CONTRIBUTING.md ***" /> > > @@ -356,12 +369,25 @@ > > </loadresource> > > <echo message="${contributing-md}" file="${commonsMojoTempDir}/ > contributing-md-template.md" append="false" /> > > > > + <!-- Without using ant-contrib: remove "-project" for > multi-module artifacts --> > > + <loadresource property="tmp.artifactId"> > > + <propertyresource name="project.artifactId" /> > > + <filterchain> > > + <tokenfilter> > > + <filetokenizer/> > > + <replacestring from="-project" to=""/> > > + </tokenfilter> > > + </filterchain> > > + </loadresource> > > + > > <!-- Copy the mail-lists template filtering to replace > properties --> > > <copy file="${commonsMojoTempDir}/contributing-md-template.md" > tofile="CONTRIBUTING.md" overwrite="true"> > > <filterset> > > - <filter token="NAME" value="${project.name}"/> > > - <filter token="ARTIFACTID" > value="${project.artifactId}"/> > > - <filter token="JIRA_ID" value="${commons.jira.id > }"/> > > + <filter token="NAME" value="${project.name > }"/> > > + <filter token="ARTIFACTID" > value="${project.artifactId}"/> > > + <filter token="ARTIFACTCOREID" > value="${tmp.artifactId}"/> > > + <filter token="JIRA_ID" value="${ > commons.jira.id}"/> > > + <filter token="ID" > value="${commons.componentid}"/> > > </filterset> > > </copy> > > > > > > Modified: > commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.mojos.xml > > URL: > http://svn.apache.org/viewvc/commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.mojos.xml?rev=1648982&r1=1648981&r2=1648982&view=diff > > > ============================================================================== > > --- > commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.mojos.xml > (original) > > +++ > commons/proper/commons-build-plugin/trunk/src/main/scripts/generate-xdocs.mojos.xml > Fri Jan 2 09:18:37 2015 > > @@ -351,6 +351,15 @@ > > <type>java.lang.String</type> > > <description>The external JIRA id for the project > (alphabetic, upper case)</description> > > </parameter> > > + <parameter> > > + <name>commons.componentid</name> > > + <property>commons.componentid</property> > > + <required>true</required> > > + <readonly>true</readonly> > > + <defaultValue>${commons.componentid}</defaultValue> > > + <type>java.lang.String</type> > > + <description>The commons component id.</description> > > + </parameter> > > </parameters> > > </mojo> > > </mojos> > > > > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org > For additional commands, e-mail: dev-h...@commons.apache.org > > -- http://people.apache.org/~britter/ http://www.systemoutprintln.de/ http://twitter.com/BenediktRitter http://github.com/britter
