Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

* Added more parameters control scm publish for site docs

  • Loading branch information...
commit c7e6a9caa9450a6c652a6c9454155cedc961e14b 1 parent 182cea8
Mike! authored

Showing 2 changed files with 33 additions and 28 deletions. Show diff stats Hide diff stats

  1. +12 7 pom.xml
  2. +21 21 src/site/xdoc/index.xml.vm
19 pom.xml
@@ -85,22 +85,25 @@
85 85 <!-- SITE DOC PROPERTIES -->
86 86 <!-- ======================== -->
87 87
88   - <!-- @OVERRIDE - Expected to be a "FILE" URI, project.artifactId will be appended automatically -->
  88 + <!-- Overwrite Expected to be a "FILE" URI, Used for site:stage-deploy -->
89 89 <site-docs.url>/${env.HOME}/sitedocs/${project.artifactId}</site-docs.url>
90   - <!-- Best practice is to override this property in your settings.xml file -->
91   - <site-docs.siteMainDirectory>${project.build.outputDirectory}/scmpublish</site-docs.siteMainDirectory>
  90 + <!-- Best practice is to override this property in your settings.xml file; used for directory to hold cloned repository -->
  91 + <scmPublish.checkoutDirectory>${project.build.directory}/scmpublish</scmPublish.checkoutDirectory>
92 92 <!-- @OVERRIDE this property per each project -->
93 93 <repository.domain>github.com</repository.domain>
94 94 <!-- @OVERRIDE this property per each project -->
95 95 <repository.user>mike-ensor</repository.user>
96 96 <!-- @OVERRIDE this property per each project -->
97 97 <repository.name>clickconcepts-master-pom</repository.name>
  98 + <!-- Overwrite this property if you are using BitBucket to add in a level of folders for multiple projects -->
  99 + <site-docs.outputDirectory>${project.reporting.outputDirectory}</site-docs.outputDirectory>
98 100
99 101 <!-- @OVERRIDE as needed -->
100 102 <scm-publish.scmBranch>gh-pages</scm-publish.scmBranch>
101 103 <!-- @OVERRIDE as needed -->
102 104 <scm-publish.pubScmUrl>scm:git:git@github.com:mike-ensor/clickconcepts-master-pom.git</scm-publish.pubScmUrl>
103   - <site-docs.siteMainDirectory>${project.reporting.outputDirectory}</site-docs.siteMainDirectory>
  105 + <!-- @OVERRIDE; This is where the content is located -->
  106 + <scmPublish.contentFolder>${project.reporting.outputDirectory}</scmPublish.contentFolder>
104 107
105 108 <!-- ======================== -->
106 109 <!-- PROJECT PROPERTIES -->
@@ -234,11 +237,12 @@
234 237 <version>${plugin.scm-publish.version}</version>
235 238 <inherited>true</inherited>
236 239 <configuration>
237   - <content>${project.reporting.outputDirectory}</content>
238   - <checkoutDirectory>${site-docs.siteMainDirectory}</checkoutDirectory>
  240 + <checkoutDirectory>${scmPublish.checkoutDirectory}</checkoutDirectory>
239 241 <checkinComment>Publishing Site Docs for ${project.artifactId}:${project.version}</checkinComment>
240   - <scmBranch>${scm-publish.scmBranch}</scmBranch>
  242 + <content>${scmPublish.contentFolder}</content>
  243 + <tryUpdate>true</tryUpdate>
241 244 <pubScmUrl>${scm-publish.pubScmUrl}</pubScmUrl>
  245 + <scmBranch>${scm-publish.scmBranch}</scmBranch>
242 246 </configuration>
243 247 </plugin>
244 248 <plugin>
@@ -542,6 +546,7 @@
542 546 <version>${plugin.site.version}</version>
543 547 <inherited>true</inherited>
544 548 <configuration>
  549 + <outputDirectory>${site-docs.outputDirectory}</outputDirectory>
545 550 <stagingDirectory>${site-docs.url}</stagingDirectory>
546 551 <attach>true</attach>
547 552 <reportPlugins>
42 src/site/xdoc/index.xml.vm
@@ -16,29 +16,29 @@
16 16
17 17 <body>
18 18
19   - <!-- The body of the document contains a number of sections -->
20   - <section name="section 1">
  19 + <h1>Master/Parent POM for Click Concepts</h1>
  20 + <p>This Master/Parent POM is intended to provide functionality for common Plugins and Site documentation.</p>
  21 + <!-- in addition to XHTML, any number of subsections can be within a section -->
  22 + <subsection name="Plugins">
  23 + <p>Plugins and versions are all up-to-date and are listed in the Parent POM</p>
  24 + <h3>Code Quality Plugins</h3>
  25 + <ul>
  26 + <li>PMD/CPD</li>
  27 + <li>Checkstyle</li>
  28 + <li>CodeNarc</li>
  29 + <li>FindBugs</li>
  30 + </ul>
  31 + </subsection>
21 32
22   - <h1>Master/Parent POM for Click Concepts</h1>
23   - <p>This is a paragraph inside of section 1</p>
24   - <!-- in addition to XHTML, any number of subsections can be within a section -->
25   - <subsection name="Plugins">
26   - <p>Plugins and versions are all up-to-date and are listed in the Parent POM</p>
27   - <h3>Code Quality Plugins</h3>
28   - <ul>
29   - <li>PMD/CPD</li>
30   - <li>Checkstyle</li>
31   - <li>CodeNarc</li>
32   - <li>FindBugs</li>
33   - </ul>
34   - </subsection>
35   - </section>
  33 + <subsection name="Site Documentation">
  34 + <p>
  35 + Add something here about site documentation
  36 + </p>
  37 + </subsection>
36 38
37   - <section name="other section">
38   - <p>This is how you run site documentation</p>
39   - <source>
40   - mvn clean verify site:run
41   - </source>
  39 + <section name="Run">
  40 + <p>Generate your site documentation</p>
  41 + <source>mvn clean verify site:stage</source>
42 42 </section>
43 43 </body>
44 44 </document>

0 comments on commit c7e6a9c

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