Skip to content
Browse files

* Added more parameters control scm publish for site docs

  • Loading branch information...
1 parent 182cea8 commit c7e6a9caa9450a6c652a6c9454155cedc961e14b @mike-ensor committed Jan 22, 2013
Showing with 33 additions and 28 deletions.
  1. +12 −7 pom.xml
  2. +21 −21 src/site/xdoc/index.xml.vm
View
19 pom.xml
@@ -85,22 +85,25 @@
<!-- SITE DOC PROPERTIES -->
<!-- ======================== -->
- <!-- @OVERRIDE - Expected to be a "FILE" URI, project.artifactId will be appended automatically -->
+ <!-- Overwrite Expected to be a "FILE" URI, Used for site:stage-deploy -->
<site-docs.url>/${env.HOME}/sitedocs/${project.artifactId}</site-docs.url>
- <!-- Best practice is to override this property in your settings.xml file -->
- <site-docs.siteMainDirectory>${project.build.outputDirectory}/scmpublish</site-docs.siteMainDirectory>
+ <!-- Best practice is to override this property in your settings.xml file; used for directory to hold cloned repository -->
+ <scmPublish.checkoutDirectory>${project.build.directory}/scmpublish</scmPublish.checkoutDirectory>
<!-- @OVERRIDE this property per each project -->
<repository.domain>github.com</repository.domain>
<!-- @OVERRIDE this property per each project -->
<repository.user>mike-ensor</repository.user>
<!-- @OVERRIDE this property per each project -->
<repository.name>clickconcepts-master-pom</repository.name>
+ <!-- Overwrite this property if you are using BitBucket to add in a level of folders for multiple projects -->
+ <site-docs.outputDirectory>${project.reporting.outputDirectory}</site-docs.outputDirectory>
<!-- @OVERRIDE as needed -->
<scm-publish.scmBranch>gh-pages</scm-publish.scmBranch>
<!-- @OVERRIDE as needed -->
<scm-publish.pubScmUrl>scm:git:git@github.com:mike-ensor/clickconcepts-master-pom.git</scm-publish.pubScmUrl>
- <site-docs.siteMainDirectory>${project.reporting.outputDirectory}</site-docs.siteMainDirectory>
+ <!-- @OVERRIDE; This is where the content is located -->
+ <scmPublish.contentFolder>${project.reporting.outputDirectory}</scmPublish.contentFolder>
<!-- ======================== -->
<!-- PROJECT PROPERTIES -->
@@ -234,11 +237,12 @@
<version>${plugin.scm-publish.version}</version>
<inherited>true</inherited>
<configuration>
- <content>${project.reporting.outputDirectory}</content>
- <checkoutDirectory>${site-docs.siteMainDirectory}</checkoutDirectory>
+ <checkoutDirectory>${scmPublish.checkoutDirectory}</checkoutDirectory>
<checkinComment>Publishing Site Docs for ${project.artifactId}:${project.version}</checkinComment>
- <scmBranch>${scm-publish.scmBranch}</scmBranch>
+ <content>${scmPublish.contentFolder}</content>
+ <tryUpdate>true</tryUpdate>
<pubScmUrl>${scm-publish.pubScmUrl}</pubScmUrl>
+ <scmBranch>${scm-publish.scmBranch}</scmBranch>
</configuration>
</plugin>
<plugin>
@@ -542,6 +546,7 @@
<version>${plugin.site.version}</version>
<inherited>true</inherited>
<configuration>
+ <outputDirectory>${site-docs.outputDirectory}</outputDirectory>
<stagingDirectory>${site-docs.url}</stagingDirectory>
<attach>true</attach>
<reportPlugins>
View
42 src/site/xdoc/index.xml.vm
@@ -16,29 +16,29 @@
<body>
- <!-- The body of the document contains a number of sections -->
- <section name="section 1">
+ <h1>Master/Parent POM for Click Concepts</h1>
+ <p>This Master/Parent POM is intended to provide functionality for common Plugins and Site documentation.</p>
+ <!-- in addition to XHTML, any number of subsections can be within a section -->
+ <subsection name="Plugins">
+ <p>Plugins and versions are all up-to-date and are listed in the Parent POM</p>
+ <h3>Code Quality Plugins</h3>
+ <ul>
+ <li>PMD/CPD</li>
+ <li>Checkstyle</li>
+ <li>CodeNarc</li>
+ <li>FindBugs</li>
+ </ul>
+ </subsection>
- <h1>Master/Parent POM for Click Concepts</h1>
- <p>This is a paragraph inside of section 1</p>
- <!-- in addition to XHTML, any number of subsections can be within a section -->
- <subsection name="Plugins">
- <p>Plugins and versions are all up-to-date and are listed in the Parent POM</p>
- <h3>Code Quality Plugins</h3>
- <ul>
- <li>PMD/CPD</li>
- <li>Checkstyle</li>
- <li>CodeNarc</li>
- <li>FindBugs</li>
- </ul>
- </subsection>
- </section>
+ <subsection name="Site Documentation">
+ <p>
+ Add something here about site documentation
+ </p>
+ </subsection>
- <section name="other section">
- <p>This is how you run site documentation</p>
- <source>
- mvn clean verify site:run
- </source>
+ <section name="Run">
+ <p>Generate your site documentation</p>
+ <source>mvn clean verify site:stage</source>
</section>
</body>
</document>

0 comments on commit c7e6a9c

Please sign in to comment.
Something went wrong with that request. Please try again.