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 2018/09/14 16:38:30 UTC
[isis] 05/06: ISIS-1811: parameterise versions in the .adoc
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch v2
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 0426ad4ed0b6ec5d9e3e0d893a98611f311311dc
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Fri Sep 14 17:36:19 2018 +0100
ISIS-1811: parameterise versions in the .adoc
---
.../src/main/asciidoc/__versions.adoc | 4 ++++
.../documentation/src/main/asciidoc/downloads.adoc | 19 ++++++++--------
.../src/main/asciidoc/guides/cgcom/__versions.adoc | 3 ---
.../guides/cgcom/_cgcom_applying-patches.adoc | 2 +-
.../cgcom/_cgcom_asciidoc-publish-procedure.adoc | 2 +-
.../guides/cgcom/_cgcom_cutting-a-release.adoc | 26 +++++++++++-----------
.../cgcom/_cgcom_post-release-successful.adoc | 4 ++--
.../cgcom/_cgcom_post-release-unsuccessful.adoc | 2 +-
...cgcom_release-process-for-interim-releases.adoc | 2 +-
.../_cgcom_release-process-for-snapshots.adoc | 2 +-
.../cgcom/_cgcom_release-process-prereqs.adoc | 2 +-
.../guides/cgcom/_cgcom_verifying-releases.adoc | 6 ++---
...ugfun_getting-started_helloworld-archetype.adoc | 7 +++---
..._ugfun_getting-started_simpleapp-archetype.adoc | 5 +++--
.../src/main/asciidoc/pages/tg/tg.adoc | 6 ++---
15 files changed, 48 insertions(+), 44 deletions(-)
diff --git a/adocs/documentation/src/main/asciidoc/__versions.adoc b/adocs/documentation/src/main/asciidoc/__versions.adoc
new file mode 100644
index 0000000..58f636b
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/__versions.adoc
@@ -0,0 +1,4 @@
+:isiscurr: 2.0.0-M1
+:isisnext: 2.0.0-M2
+:isisnextafter: 2.0.0-M3
+:isisdev: {isisnext}-SNAPSHOT
\ No newline at end of file
diff --git a/adocs/documentation/src/main/asciidoc/downloads.adoc b/adocs/documentation/src/main/asciidoc/downloads.adoc
index 7fac77f..87c8f9d 100644
--- a/adocs/documentation/src/main/asciidoc/downloads.adoc
+++ b/adocs/documentation/src/main/asciidoc/downloads.adoc
@@ -4,6 +4,7 @@
:_basedir: ./
:_imagesdir: images/
:toc: right
+include::__versions.adoc[]
Apache Isis™ software is a framework for rapidly developing domain-driven apps in Java.
@@ -25,15 +26,15 @@ If you want to build Apache Isis from formally released source tarballs, you can
Core:
-* https://www.apache.org/dyn/closer.cgi/isis/isis-core/isis-1.16.2-source-release.zip[isis-1.16.2] (https://www.apache.org/dist/isis/isis-core/isis-1.16.2-source-release.zip.asc[asc], https://www.apache.org/dist/isis/isis-core/isis-1.16.2-source-release.zip.md5[md5])
+* https://www.apache.org/dyn/closer.cgi/isis/isis-core/isis-{isiscurr}-source-release.zip[isis-{isiscurr}] (https://www.apache.org/dist/isis/isis-core/isis-{isiscurr}-source-release.zip.asc[asc], https://www.apache.org/dist/isis/isis-core/isis-{isiscurr}-source-release.zip.md5[md5])
HelloWorld Archetype:
-* https://www.apache.org/dyn/closer.cgi/isis/archetype/helloworld-archetype/helloworld-archetype-1.16.2-source-release.zip[helloworld-archetype-1.16.2] (https://www.apache.org/dist/isis/archetype/helloworld-archetype/helloworld-archetype-1.16.2-source-release.zip.asc[asc], https://www.apache.org/dist/isis/archetype/helloworld-archetype/helloworld-archetype-1.16.2-source-release.zip.md5[md5])
+* https://www.apache.org/dyn/closer.cgi/isis/archetype/helloworld-archetype/helloworld-archetype-{isiscurr}-source-release.zip[helloworld-archetype-{isiscurr}] (https://www.apache.org/dist/isis/archetype/helloworld-archetype/helloworld-archetype-{isiscurr}-source-release.zip.asc[asc], https://www.apache.org/dist/isis/archetype/helloworld-archetype/helloworld-archetype-{isiscurr}-source-release.zip.md5[md5])
SimpleApp Archetype:
-* https://www.apache.org/dyn/closer.cgi/isis/archetype/simpleapp-archetype/simpleapp-archetype-1.16.2-source-release.zip[simpleapp-archetype-1.16.2] (https://www.apache.org/dist/isis/archetype/simpleapp-archetype/simpleapp-archetype-1.16.2-source-release.zip.asc[asc], https://www.apache.org/dist/isis/archetype/simpleapp-archetype/simpleapp-archetype-1.16.2-source-release.zip.md5[md5])
+* https://www.apache.org/dyn/closer.cgi/isis/archetype/simpleapp-archetype/simpleapp-archetype-{isiscurr}-source-release.zip[simpleapp-archetype-{isiscurr}] (https://www.apache.org/dist/isis/archetype/simpleapp-archetype/simpleapp-archetype-{isiscurr}-source-release.zip.asc[asc], https://www.apache.org/dist/isis/archetype/simpleapp-archetype/simpleapp-archetype-{isiscurr}-source-release.zip.md5[md5])
@@ -47,26 +48,26 @@ Make sure you get these files from the http://www.apache.org/dist/isis/[main dis
Then verify the signatures using a command such as:
-[source,bash]
+[source,bash,subs="attributes+"]
----
pgpk -a KEYS
-pgpv isis-1.16.2-source-release.zip.asc isis-1.16.2-source-release.zip
+pgpv isis-{isiscurr}-source-release.zip.asc isis-{isiscurr}-source-release.zip
----
or
-[source,bash]
+[source,bash,subs="attributes+"]
----
pgp -ka KEYS
-pgp isis-1.16.2-source-release.zip.asc isis-1.16.2-source-release.zip
+pgp isis-{isiscurr}-source-release.zip.asc isis-{isiscurr}-source-release.zip
----
or
-[source,bash]
+[source,bash,subs="attributes+"]
----
gpg –import KEYS
-gpg -verify isis-1.16.2-source-release.zip.asc isis-1.16.2-source-release.zip
+gpg -verify isis-{isiscurr}-source-release.zip.asc isis-{isiscurr}-source-release.zip
----
diff --git a/adocs/documentation/src/main/asciidoc/guides/cgcom/__versions.adoc b/adocs/documentation/src/main/asciidoc/guides/cgcom/__versions.adoc
deleted file mode 100644
index 443d440..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/cgcom/__versions.adoc
+++ /dev/null
@@ -1,3 +0,0 @@
-:isisprev: 2.0.0-M1
-:isisrel: 2.0.0-M2
-:isisdev: {isisrel}-SNAPSHOT
\ No newline at end of file
diff --git a/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_applying-patches.adoc b/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_applying-patches.adoc
index 77dae72..bb15baa 100644
--- a/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_applying-patches.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_applying-patches.adoc
@@ -4,7 +4,7 @@
:_basedir: ../../
:_imagesdir: images/
:toc: right
-include::__versions.adoc[]
+include::../../__versions.adoc[]
diff --git a/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_asciidoc-publish-procedure.adoc b/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_asciidoc-publish-procedure.adoc
index 217f243..c7fd688 100644
--- a/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_asciidoc-publish-procedure.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_asciidoc-publish-procedure.adoc
@@ -3,7 +3,7 @@
:notice: licensed to the apache software foundation (asf) under one or more contributor license agreements. see the notice file distributed with this work for additional information regarding copyright ownership. the asf licenses this file to you under the apache license, version 2.0 (the "license"); you may not use this file except in compliance with the license. you may obtain a copy of the license at. http://www.apache.org/licenses/license-2.0 . unless required by applicable law or ag [...]
:_imagesdir: images/
:toc: right
-include::__versions.adoc[]
+include::../../__versions.adoc[]
Apache Isis' documentation (meaning the website and the users' guide, the reference guide and this contributors' guide) is written using link:http://www.methods.co.nz/asciidoc/[Asciidoc], specifically the link:http://asciidoctor.org/[Asciidoctor] implementation.
diff --git a/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_cutting-a-release.adoc b/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_cutting-a-release.adoc
index c207fb5..8ccb84e 100644
--- a/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_cutting-a-release.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_cutting-a-release.adoc
@@ -4,7 +4,7 @@
:_basedir: ../../
:_imagesdir: images/
:toc: right
-include::__versions.adoc[]
+include::../../__versions.adoc[]
The release process consists of:
@@ -55,7 +55,7 @@ For example:
----
export ISISTMP=/c/tmp # <1>
export ISISDEV={isisdev}
-export ISISREL={isisrel}
+export ISISREL={isisnext}
export ISISRC=RC1
export ISISBRANCH=release-$ISISREL-$ISISRC
export ISISJIRA=ISIS-9999 # <2>
@@ -72,7 +72,7 @@ Obviously, alter `$ISISDEV` and `$ISISREL` as required, and bump `$ISISRC` for r
[IMPORTANT]
====
-Note that the branch name is intentionally *not* the same any of the eventual tag names (eg `isis-{isisrel}` or `simpleapp-archetype-{isisrel}`).
+Note that the branch name is intentionally *not* the same any of the eventual tag names (eg `isis-{isisnext}` or `simpleapp-archetype-{isisnext}`).
====
@@ -99,7 +99,7 @@ This will normally have been done already during earlier development; but confir
If it has not, make the change.
Double check that the version number of the core POM (`core/pom.xml`) should reflect the branch name that you are now on.
-For example, if releasing version `{isisrel}`, the POM should read:
+For example, if releasing version `{isisnext}`, the POM should read:
[source,xml,subs="attributes+"]
----
@@ -835,7 +835,7 @@ Use the following subject, eg:
[source,bash,subs="attributes+"]
----
-[VOTE] Apache Isis Core release {isisrel} RC1
+[VOTE] Apache Isis Core release {isisnext} RC1
----
And use the following body:
@@ -844,19 +844,19 @@ And use the following body:
----
I've cut a release for Apache Isis Core and the two archetypes:
-* Core {isisrel}
-* HelloWorld Archetype {isisrel}
-* SimpleApp Archetype {isisrel}
+* Core {isisnext}
+* HelloWorld Archetype {isisnext}
+* SimpleApp Archetype {isisnext}
The source code artifacts have been uploaded to staging repositories on repository.apache.org:
-* http://repository.apache.org/content/repositories/orgapacheisis-10xx/org/apache/isis/core/isis/{isisrel}/isis-{isisrel}-source-release.zip
-* http://repository.apache.org/content/repositories/orgapacheisis-10xx/org/apache/isis/archetype/helloworld-archetype/{isisrel}/helloworld-archetype-{isisrel}-source-release.zip
-* http://repository.apache.org/content/repositories/orgapacheisis-10xx/org/apache/isis/archetype/simpleapp-archetype/{isisrel}/simpleapp-archetype-{isisrel}-source-release.zip
+* http://repository.apache.org/content/repositories/orgapacheisis-10xx/org/apache/isis/core/isis/{isisnext}/isis-{isisnext}-source-release.zip
+* http://repository.apache.org/content/repositories/orgapacheisis-10xx/org/apache/isis/archetype/helloworld-archetype/{isisnext}/helloworld-archetype-{isisnext}-source-release.zip
+* http://repository.apache.org/content/repositories/orgapacheisis-10xx/org/apache/isis/archetype/simpleapp-archetype/{isisnext}/simpleapp-archetype-{isisnext}-source-release.zip
For each zip there is a corresponding signature file (append .asc to the zip's url).
-In the source code repo the code has been tagged as isis-{isisrel}-RC1, helloworld-archetype-{isisrel}-RC1 and simpleapp-archetype-{isisrel}-RC1; see https://github.com/apache/isis/tags
+In the source code repo the code has been tagged as isis-{isisnext}-RC1, helloworld-archetype-{isisnext}-RC1 and simpleapp-archetype-{isisnext}-RC1; see https://github.com/apache/isis/tags
For instructions on how to verify the release (build from binaries and/or use in Maven directly), see https://isis.apache.org/guides/cgcom/cgcom.html#_cgcom_verifying-releases
@@ -869,7 +869,7 @@ Please verify the release and cast your vote. The vote will be open for a minim
Remember to update:
-* the version number (`{isisrel}` or whatever)
+* the version number (`{isisnext}` or whatever)
* the release candidate number (`RC1` or whatever)
* the repository id, as provided by Nexus earlier (`orgapacheisis-10xx` or whatever)
diff --git a/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_post-release-successful.adoc b/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_post-release-successful.adoc
index a8348f7..b674d3b 100644
--- a/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_post-release-successful.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_post-release-successful.adoc
@@ -4,7 +4,7 @@
:_basedir: ../../
:_imagesdir: images/
:toc: right
-include::__versions.adoc[]
+include::../../__versions.adoc[]
The release process consists of:
@@ -190,7 +190,7 @@ popd
[source,bash,subs="attributes+"]
----
-sh upd.sh {isisprev} {isisrel}
+sh upd.sh {isiscurr} {isisnext}
----
The script downloads the artifacts from the Nexus release repository, adds the artifacts to subversion and deletes the previous version.
diff --git a/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_post-release-unsuccessful.adoc b/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_post-release-unsuccessful.adoc
index f440b5e..6a6b2c7 100644
--- a/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_post-release-unsuccessful.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_post-release-unsuccessful.adoc
@@ -4,7 +4,7 @@
:_basedir: ../../
:_imagesdir: images/
:toc: right
-include::__versions.adoc[]
+include::../../__versions.adoc[]
The release process consists of:
diff --git a/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_release-process-for-interim-releases.adoc b/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_release-process-for-interim-releases.adoc
index 9abffb9..ebeed88 100644
--- a/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_release-process-for-interim-releases.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_release-process-for-interim-releases.adoc
@@ -4,7 +4,7 @@
:_basedir: ../../
:_imagesdir: images/
:toc: right
-include::__versions.adoc[]
+include::../../__versions.adoc[]
The intent of an "interim" release is to allow a developer team to release their application based on a `-SNAPSHOT` version of the framework.
diff --git a/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_release-process-for-snapshots.adoc b/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_release-process-for-snapshots.adoc
index af6be3d..ec0bdc1 100644
--- a/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_release-process-for-snapshots.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_release-process-for-snapshots.adoc
@@ -4,7 +4,7 @@
:_basedir: ../../
:_imagesdir: images/
:toc: right
-include::__versions.adoc[]
+include::../../__versions.adoc[]
Snapshot releases allows the current `-SNAPSHOT` version of the `core` modules of the framework to be released to the Maven snapshot repository maintained by Apache Software Foundation.
diff --git a/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_release-process-prereqs.adoc b/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_release-process-prereqs.adoc
index 178b878..af829e7 100644
--- a/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_release-process-prereqs.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_release-process-prereqs.adoc
@@ -4,7 +4,7 @@
:_basedir: ../../
:_imagesdir: images/
:toc: right
-include::__versions.adoc[]
+include::../../__versions.adoc[]
diff --git a/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_verifying-releases.adoc b/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_verifying-releases.adoc
index eed2a8f..e84d830 100644
--- a/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_verifying-releases.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/cgcom/_cgcom_verifying-releases.adoc
@@ -4,7 +4,7 @@
:_basedir: ../../
:_imagesdir: images/
:toc: right
-include::__versions.adoc[]
+include::../../__versions.adoc[]
The release process consists of:
@@ -236,7 +236,7 @@ mvn archetype:generate \
-D archetypeCatalog=local \
-D archetypeGroupId=org.apache.isis.archetype \
-D archetypeArtifactId=helloworld-archetype \
- -D archetypeVersion={isisrel} \
+ -D archetypeVersion={isisnext} \
-D groupId=com.mycompany \
-D artifactId=myhelloworld \
-D version=1.0-SNAPSHOT \
@@ -259,7 +259,7 @@ mvn archetype:generate \
-D archetypeCatalog=local \
-D archetypeGroupId=org.apache.isis.archetype \
-D archetypeArtifactId=simpleapp-archetype \
- -D archetypeVersion={isisrel} \
+ -D archetypeVersion={isisnext} \
-D groupId=com.mycompany \
-D artifactId=mysimpleapp \
-D version=1.0-SNAPSHOT \
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_helloworld-archetype.adoc b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_helloworld-archetype.adoc
index b4ff590..e136477 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_helloworld-archetype.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_helloworld-archetype.adoc
@@ -3,7 +3,8 @@
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
:_basedir: ../../
:_imagesdir: images/
-
+:toc:
+include::../../__versions.adoc[]
The quickest way to start learning about Apache Isis is to run the `helloworld` archetype.
@@ -28,12 +29,12 @@ Create a new directory, and `cd` into that directory.
To build the app from the latest stable release, then run the following command:
-[source,bash]
+[source,bash,subs="attributes+"]
----
mvn archetype:generate \
-D archetypeGroupId=org.apache.isis.archetype \
-D archetypeArtifactId=helloworld-archetype \
- -D archetypeVersion=1.16.2 \
+ -D archetypeVersion={isiscurr} \
-D groupId=com.mycompany \
-D artifactId=myapp \
-D version=1.0-SNAPSHOT \
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_simpleapp-archetype.adoc b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_simpleapp-archetype.adoc
index 63a1132..dea5ecf 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_simpleapp-archetype.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_simpleapp-archetype.adoc
@@ -4,6 +4,7 @@
:_basedir: ../../
:_imagesdir: images/
:toc:
+include::../../__versions.adoc[]
The quickest way to get started building an application "for real" is to run the `simpleapp` archetype.
Like the xref:ugfun.adoc#_ugfun_getting-started_helloworld-archetype[helloworld archetype], this too will generate a very simple one-class domain model (an entity called `SimpleObject` with a couple of properties).
@@ -27,12 +28,12 @@ Create a new directory, and `cd` into that directory.
To build the app from the latest stable release, then run the following command:
-[source,bash]
+[source,bash,subs="attributes+"]
----
mvn archetype:generate \
-D archetypeGroupId=org.apache.isis.archetype \
-D archetypeArtifactId=simpleapp-archetype \
- -D archetypeVersion=1.16.2 \
+ -D archetypeVersion={isiscurr} \
-D groupId=com.mycompany \
-D artifactId=myapp \
-D version=1.0-SNAPSHOT \
diff --git a/adocs/documentation/src/main/asciidoc/pages/tg/tg.adoc b/adocs/documentation/src/main/asciidoc/pages/tg/tg.adoc
index 17ec48d..8ffcf40 100644
--- a/adocs/documentation/src/main/asciidoc/pages/tg/tg.adoc
+++ b/adocs/documentation/src/main/asciidoc/pages/tg/tg.adoc
@@ -4,7 +4,7 @@
:_basedir: ../../
:_imagesdir: images/
:numbered:
-
+include::../../__versions.adoc[]
This is a half-day tutorial on developing domain-driven apps using Apache Isis.
@@ -30,12 +30,12 @@ Run the simpleapp archetype to build an empty Isis application.
With the *nix bash shell, use:
-[source,bash]
+[source,bash,subs="attributes+"]
----
mvn archetype:generate \
-D archetypeGroupId=org.apache.isis.archetype \
-D archetypeArtifactId=simpleapp-archetype \
- -D archetypeVersion=1.16.2 \
+ -D archetypeVersion={isiscurr} \
-D groupId=com.mycompany \
-D artifactId=myapp \
-D version=1.0-SNAPSHOT \