You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2017/02/21 00:10:10 UTC
[2/2] isis-site git commit: ISIS-1561: updates to post-release
procedures
ISIS-1561: updates to post-release procedures
Project: http://git-wip-us.apache.org/repos/asf/isis-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis-site/commit/07d45085
Tree: http://git-wip-us.apache.org/repos/asf/isis-site/tree/07d45085
Diff: http://git-wip-us.apache.org/repos/asf/isis-site/diff/07d45085
Branch: refs/heads/asf-site
Commit: 07d45085e09d0c3f8d2e058f89bcd3e42564b288
Parents: f2c7f11
Author: Dan Haywood <da...@haywood-associates.co.uk>
Authored: Tue Feb 21 00:08:09 2017 +0000
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Tue Feb 21 00:08:09 2017 +0000
----------------------------------------------------------------------
content/guides/cgcom.html | 287 +-
content/guides/cgcom.pdf | 7827 +++++++++++++++++++++++++++-------------
2 files changed, 5578 insertions(+), 2536 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/isis-site/blob/07d45085/content/guides/cgcom.html
----------------------------------------------------------------------
diff --git a/content/guides/cgcom.html b/content/guides/cgcom.html
index f312411..52c8efb 100644
--- a/content/guides/cgcom.html
+++ b/content/guides/cgcom.html
@@ -2482,7 +2482,79 @@ git push</code></pre>
</div>
</div>
<div class="sect2">
-<h3 id="_release_isis_addons">5.13. Release Isis Addons</h3>
+<h3 id="_cgcom_post-release-successful_release-non-asf-modules">5.13. Release (non-ASF) Modules</h3>
+<div class="paragraph">
+<p>There are two libraries of modules, both non-ASF but open source, that should be released.</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p><a href="http://isisaddons.org">Isis Addons</a> - modules addressing technical concerns</p>
+</li>
+<li>
+<p><a href="http://catalog.incodehq.org">Incode Catalog</a> - modules for various generic business subdomains</p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p>These each use a common parent, <code>org.incode:incode-parent</code>.
+This must be released first, then both set of modules afterwards.</p>
+</div>
+<div class="sect3">
+<h4 id="_cgcom_post-release-successful_release-non-asf-modules_prereqs">5.13.1. Prereqs</h4>
+<div class="paragraph">
+<p>Save this <a href="https://gist.github.com/danhaywood/e80daf6d25f5c1fb1093effba85d088a">gist</a> as <code>last_modified.sh</code> in an appropriate parent directory of both sets of repos.</p>
+</div>
+<div class="paragraph">
+<p>For example, if the isisaddons modules are cloned to <code>/c/github/isisaddons/isis-module-xxx</code> and the incode catalog modules are cloned to <code>/c/github/incodehq/incode-module-xxx</code>, then save in <code>/c/github</code>.</p>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_cgcom_post-release-successful_release-non-asf-modules_incode-parent">5.13.2. Release <code>incode-parent</code></h4>
+<div class="paragraph">
+<p>The <code>org.incode:incode-parent</code> Maven module is used as a parent for both sets of modules:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>Open up <code>pom.xml</code>, and manually edit <code><isis.version></code> property to the latest release</p>
+</li>
+<li>
+<p>update the README</p>
+<div class="ulist">
+<ul>
+<li>
+<p>replace each version with next (ie the "How to Configure/Use" section, and the "Release to Maven Central" section at the end):</p>
+<div class="ulist">
+<ul>
+<li>
+<p>replace 1.14.0-SNAPSHOT with 1.15.0-SNAPSHOT</p>
+</li>
+<li>
+<p>replace 1.13.0 with 1.14.0</p>
+</li>
+</ul>
+</div>
+</li>
+<li>
+<p>update the "Change Log" section</p>
+</li>
+</ul>
+</div>
+</li>
+<li>
+<p>Release using:<br></p>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="bash">sh release.sh "1.14.0" "1.15.0-SNAPSHOT" "dan@haywood-associates.co.uk" "this is not really my password"</code></pre>
+</div>
+</div>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_cgcom_post-release-successful_release-non-asf-modules_isisaddons">5.13.3. Release Isis Addons</h4>
<div class="paragraph">
<p>Once the Apache Isis release is available, all of the (non-ASF) <a href="http://isisaddons.org">Isis Addons</a> should also be released.</p>
</div>
@@ -2495,23 +2567,50 @@ git push</code></pre>
<p>update its dependency on Apache Isis to reference the newly released version:<br></p>
<div class="listingblock">
<div class="content">
-<pre class="CodeRay highlight"><code data-lang="bash">foreach -g isisaddons bumpver_isis.sh 1.14.0</code></pre>
+<pre class="CodeRay highlight"><code data-lang="bash">foreach -g isisaddons sh bumpver_isis.sh 1.14.0</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>and use:<br></p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="bash">foreach -g isisaddons git diff HEAD^ HEAD</code></pre>
</div>
</div>
+<div class="paragraph">
+<p>and:<br></p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="bash">foreach -g isisaddons git status --branch --porcelain</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>to review changes made.</p>
+</div>
</li>
<li>
-<p>update the README for each repository</p>
+<p>update the README for each repository.</p>
<div class="ulist">
<ul>
<li>
+<p>if using Windows, then:<br></p>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="bash">"C:\Program Files (x86)\Notepad++\notepad++.exe" isisaddons/isis-m*/README.adoc isisaddons/isis-w*/README.adoc</code></pre>
+</div>
+</div>
+</li>
+<li>
<p>replace each version with next (ie the "How to Configure/Use" section, and the "Release to Maven Central" section at the end):</p>
<div class="ulist">
<ul>
<li>
-<p>replace 1.14.0-SNAPSHOT with 1.15.0-SNAPSHOT</p>
+<p>replace <code>1.14.0</code> with <code>1.15.0</code></p>
</li>
<li>
-<p>replace 1.13.0 with 1.14.0</p>
+<p>replace <code>1.13.0</code> with <code>1.14.0</code> as necessary (pretty much everywhere apart from the "Change Log")</p>
</li>
</ul>
</div>
@@ -2531,18 +2630,40 @@ git push</code></pre>
</div>
</li>
<li>
-<p>update its dependency on Apache Isis to reference the next SNAPSHOT version:<br></p>
+<p>In the parent directory where the <code>last_modified.sh</code> script has been saved (see <a href="#_cgcom_post-release-successful_release-non-asf-modules_prereqs">above</a>), use to check that all modules were released successfully:<br></p>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="bash">foreach -g isisaddons/isis-[mw] sh ../../last-modified.sh 1.14.0</code></pre>
+</div>
+</div>
+<div class="admonitionblock important">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-important" title="Important"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>Wait at least 10 minutes to check; sync’ing to Maven central from the Sonatype OSS repository isn’t instaneous.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
+</li>
+<li>
+<p>Assuming everything did get published ok, then push branch and tag:<br></p>
<div class="listingblock">
<div class="content">
-<pre class="CodeRay highlight"><code data-lang="bash">foreach -g isisaddons sh bumpver_isis.sh "1.15.0-SNAPSHOT"</code></pre>
+<pre class="CodeRay highlight"><code data-lang="bash">foreach -g isisaddons/isis-[mw] "git push origin master && git push origin 1.14.0"</code></pre>
</div>
</div>
</li>
</ul>
</div>
</div>
-<div class="sect2">
-<h3 id="_release_incode_catalog_modules">5.14. Release Incode Catalog Modules</h3>
+<div class="sect3">
+<h4 id="_cgcom_post-release-successful_release-non-asf-modules_incode-catalog">5.13.4. Release Incode Catalog Modules</h4>
<div class="paragraph">
<p>Similarly, all of the (non-ASF) <a href="http://catalog.incode.org">Incode Catalog</a> modules should also be released.</p>
</div>
@@ -2555,23 +2676,31 @@ git push</code></pre>
<p>update its dependency on Apache Isis to reference the newly released version:<br></p>
<div class="listingblock">
<div class="content">
-<pre class="CodeRay highlight"><code data-lang="bash">foreach -g incodehq/incode- bumpver_isis.sh 1.14.0</code></pre>
+<pre class="CodeRay highlight"><code data-lang="bash">foreach -g incodehq/incode-module sh bumpver_isis.sh 1.14.0</code></pre>
</div>
</div>
</li>
<li>
-<p>update the README for each repository</p>
+<p>update the README for each repository.<br></p>
+<div class="paragraph">
+<p>eg if using Windows, then:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="bash">"C:\Program Files (x86)\Notepad++\notepad++.exe" incodehq/incode-*/README.adoc</code></pre>
+</div>
+</div>
<div class="ulist">
<ul>
<li>
-<p>replace each version with next (ie the "How to Configure/Use" section, and the "Release to Maven Central" section at the end):</p>
+<p>Replace each version with next (ie the "How to Configure/Use" section, and the "Release to Maven Central" section at the end):</p>
<div class="ulist">
<ul>
<li>
-<p>replace 1.14.0-SNAPSHOT with 1.15.0-SNAPSHOT</p>
+<p>replace <code>1.14.0</code> with <code>1.15.0</code></p>
</li>
<li>
-<p>replace 1.13.0 with 1.14.0</p>
+<p>replace <code>1.13.0</code> with <code>1.14.0</code> as necessary (pretty much everywhere apart from the "Change Log")</p>
</li>
</ul>
</div>
@@ -2583,23 +2712,133 @@ git push</code></pre>
</div>
</li>
<li>
+<p>update cross-module dependencies<br></p>
+<div class="paragraph">
+<p>Some of the incode catalog modules depend on isisaddons modules, and also on each other.<br></p>
+</div>
+<div class="paragraph">
+<p>eg if using Windows, then:<br></p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="bash">"C:\Program Files (x86)\Notepad++\notepad++.exe" incodehq/incode-module*/pom.xml incodehq/incode-module-*/dom/pom.xml incodehq/incode-module-*/module/pom.xml</code></pre>
+</div>
+</div>
+<div class="admonitionblock tip">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-tip" title="Tip"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>See <a href="#_cgcom_post-release-successful_release-non-asf-modules_incode-catalog_cross-module-dependencies">below</a> for a list of the dependencies to update.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
+</li>
+<li>
+<p>If necessary, adjust the <code>_repos.txt</code> file (used by <code>foreach</code> function) so that repositories are released in the correct sequence (with respect to their mutual dependencies).
+For example, <code>incode-module-base</code> must be released prior to <code>incode-module-alias</code>.</p>
+</li>
+<li>
<p>release the <code>incode-module-???</code> modules to mvn central (contains a sanity check before hand that everything compiles):<br></p>
<div class="listingblock">
<div class="content">
-<pre class="CodeRay highlight"><code data-lang="bash">foreach -g incodehq/incode-[a-w] sh release.sh "1.14.0" "1.15.0-SNAPSHOT" "dan@haywood-associates.co.uk" \"this is not really my password\"</code></pre>
+<pre class="CodeRay highlight"><code data-lang="bash">foreach -g incodehq/incode-module-[a-w] sh release.sh "1.14.0" "1.15.0-SNAPSHOT" "dan@haywood-associates.co.uk" \"this is not really my password\"</code></pre>
</div>
</div>
</li>
<li>
-<p>update its dependency on Apache Isis to reference the next SNAPSHOT version:<br></p>
+<p>In the parent directory where the <code>last_modified.sh</code> script has been saved (see <a href="#_cgcom_post-release-successful_release-non-asf-modules_prereqs">above</a>), use to check that all modules were released successfully:<br></p>
<div class="listingblock">
<div class="content">
-<pre class="CodeRay highlight"><code data-lang="bash">foreach -g isisaddons sh bumpver_isis.sh "1.15.0-SNAPSHOT"</code></pre>
+<pre class="CodeRay highlight"><code data-lang="bash">foreach -g incodehq/incode-module-[a-w] sh ../../last-modified.sh 1.14.0</code></pre>
+</div>
+</div>
+<div class="admonitionblock important">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-important" title="Important"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>Wait at least 10 minutes to check; sync’ing to Maven central from the Sonatype OSS repository isn’t instaneous.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
+</li>
+<li>
+<p>Assuming everything did get published ok, then push branch and tag:<br></p>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="bash">foreach -g incodehq/incode-module-[a-w] "git push origin master && git push origin 1.14.0"</code></pre>
</div>
</div>
</li>
</ul>
</div>
+<div class="sect4">
+<h5 id="_cgcom_post-release-successful_release-non-asf-modules_incode-catalog_cross-module-dependencies">Cross-module dependencies</h5>
+<div class="paragraph">
+<p>As of v1.14.0, the list of dependencies that needed to be updated (across all modules) were:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p><code><isis-module-fakedata.version>1.14.0</isis-module-fakedata.version></code></p>
+</li>
+<li>
+<p><code><isis-module-freemarker.version>1.14.0</isis-module-freemarker.version></code></p>
+</li>
+<li>
+<p><code><isis-wicket-fullcalendar2-cpt.version>1.14.0</isis-wicket-fullcalendar2-cpt.version></code></p>
+</li>
+<li>
+<p><code><isis-wicket-gmap3-cpt.version>1.14.0</isis-wicket-gmap3-cpt.version></code></p>
+</li>
+<li>
+<p><code><isis-module-poly.version>1.14.0</isis-module-poly.version></code></p>
+</li>
+<li>
+<p><code><isis-module-security.version>1.14.0</isis-module-security.version></code></p>
+</li>
+<li>
+<p><code><incode-module-base.version>1.14.0</incode-module-base.version></code></p>
+</li>
+<li>
+<p><code><incode-module-fixturesupport.version>1.14.0</incode-module-fixturesupport.version></code></p>
+</li>
+<li>
+<p><code><incode-module-unittestsupport.version>1.14.0</incode-module-unittestsupport.version></code></p>
+</li>
+<li>
+<p><code><incode-module-integtestsupport.version>1.14.0</incode-module-integtestsupport.version></code></p>
+</li>
+<li>
+<p><code><incode-module-country.version>1.14.0</incode-module-country.version></code></p>
+</li>
+<li>
+<p><code><incode-module-document.version>1.14.0</incode-module-document.version></code></p>
+</li>
+<li>
+<p><code><incode-module-docrendering-freemarker.version>1.14.0</incode-module-docrendering-freemarker.version></code></p>
+</li>
+<li>
+<p><code><incode-module-docrendering-stringinterpolator.version>1.14.0</incode-module-docrendering-stringinterpolator.version></code></p>
+</li>
+<li>
+<p><code><incode-module-docrendering-xdocreport.version>1.14.0</incode-module-docrendering-xdocreport.version></code></p>
+</li>
+</ul>
+</div>
+</div>
+</div>
</div>
</div>
</div>
@@ -4570,8 +4809,18 @@ modify_committee.pl isis --remove joebloggs</code></pre>
</li>
<li><a href="#_code_formatting">5.11. Code formatting</a></li>
<li><a href="#_push_changes">5.12. Push changes</a></li>
-<li><a href="#_release_isis_addons">5.13. Release Isis Addons</a></li>
-<li><a href="#_release_incode_catalog_modules">5.14. Release Incode Catalog Modules</a></li>
+<li><a href="#_cgcom_post-release-successful_release-non-asf-modules">5.13. Release (non-ASF) Modules</a>
+<ul class="sectlevel3">
+<li><a href="#_cgcom_post-release-successful_release-non-asf-modules_prereqs">5.13.1. Prereqs</a></li>
+<li><a href="#_cgcom_post-release-successful_release-non-asf-modules_incode-parent">5.13.2. Release <code>incode-parent</code></a></li>
+<li><a href="#_cgcom_post-release-successful_release-non-asf-modules_isisaddons">5.13.3. Release Isis Addons</a></li>
+<li><a href="#_cgcom_post-release-successful_release-non-asf-modules_incode-catalog">5.13.4. Release Incode Catalog Modules</a>
+<ul class="sectlevel4">
+<li><a href="#_cgcom_post-release-successful_release-non-asf-modules_incode-catalog_cross-module-dependencies">Cross-module dependencies</a></li>
+</ul>
+</li>
+</ul>
+</li>
</ul>
</li>
<li><a href="#_cgcom_post-release-unsuccessful">6. Post Release (Unsuccessful)</a>