This is an automated email from the ASF dual-hosted git repository. danhaywood pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/isis.git
commit 22589dc0bd1ad929ee5a261af9ca2e6224557cdc Author: Dan Haywood <[email protected]> AuthorDate: Mon Jan 8 21:05:19 2018 +0000 ISIS-1465: updates to website/docs --- .../documentation/src/main/asciidoc/doap_isis.rdf | 24 ++++++++ .../documentation/src/main/asciidoc/downloads.adoc | 12 ++-- .../guides/cgcom/_cgcom_cutting-a-release.adoc | 30 +++++----- .../cgcom/_cgcom_post-release-successful.adoc | 66 ++++++++++++++++------ .../cgcom/_cgcom_post-release-unsuccessful.adoc | 16 +++--- .../guides/cgcom/_cgcom_verifying-releases.adoc | 4 +- ...ugfun_getting-started_helloworld-archetype.adoc | 2 +- .../tg/_tg_stop-scaffolding-start-coding.adoc | 2 +- .../main/asciidoc/release-notes/release-notes.adoc | 2 +- 9 files changed, 108 insertions(+), 50 deletions(-) diff --git a/adocs/documentation/src/main/asciidoc/doap_isis.rdf b/adocs/documentation/src/main/asciidoc/doap_isis.rdf index 1c37ae4..8455086 100644 --- a/adocs/documentation/src/main/asciidoc/doap_isis.rdf +++ b/adocs/documentation/src/main/asciidoc/doap_isis.rdf @@ -36,6 +36,30 @@ <category rdf:resource="http://projects.apache.org/category/web-framework"; /> + <!-- 2018-01-08 releases --> + <release> + <Version> + <name>isis</name> + <created>2018-01-08</created> + <revision>1.16.0</revision> + </Version> + </release> + <release> + <Version> + <name>helloworld-archetype</name> + <created>2018-01-08</created> + <revision>1.16.0</revision> + </Version> + </release> + <release> + <Version> + <name>simpleapp-archetype</name> + <created>2018-01-08</created> + <revision>1.16.0</revision> + </Version> + </release> + + <!-- 2017-09-25 releases --> <release> <Version> diff --git a/adocs/documentation/src/main/asciidoc/downloads.adoc b/adocs/documentation/src/main/asciidoc/downloads.adoc index 438c2ac..d271f84 100644 --- a/adocs/documentation/src/main/asciidoc/downloads.adoc +++ b/adocs/documentation/src/main/asciidoc/downloads.adoc @@ -25,15 +25,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.15.1-source-release.zip[isis-1.15.1] (https://www.apache.org/dist/isis/isis-core/isis-1.15.1-source-release.zip.asc[asc], https://www.apache.org/dist/isis/isis-core/isis-1.15.1-source-release.zip.md5[md5]) +* https://www.apache.org/dyn/closer.cgi/isis/isis-core/isis-1.16.0-source-release.zip[isis-1.16.0] (https://www.apache.org/dist/isis/isis-core/isis-1.16.0-source-release.zip.asc[asc], https://www.apache.org/dist/isis/isis-core/isis-1.16.0-source-release.zip.md5[md5]) HelloWorld Archetype: -* https://www.apache.org/dyn/closer.cgi/isis/archetype/helloworld-archetype/helloworld-archetype-1.15.1-source-release.zip[helloworld-archetype-1.15.1] (https://www.apache.org/dist/isis/archetype/helloworld-archetype/helloworld-archetype-1.15.1-source-release.zip.asc[asc], https://www.apache.org/dist/isis/archetype/helloworld-archetype/helloworld-archetype-1.15.1-source-release.zip.md5[md5]) +* https://www.apache.org/dyn/closer.cgi/isis/archetype/helloworld-archetype/helloworld-archetype-1.16.0-source-release.zip[helloworld-archetype-1.16.0] (https://www.apache.org/dist/isis/archetype/helloworld-archetype/helloworld-archetype-1.16.0-source-release.zip.asc[asc], https://www.apache.org/dist/isis/archetype/helloworld-archetype/helloworld-archetype-1.16.0-source-release.zip.md5[md5]) SimpleApp Archetype: -* https://www.apache.org/dyn/closer.cgi/isis/archetype/simpleapp-archetype/simpleapp-archetype-1.15.1-source-release.zip[simpleapp-archetype-1.15.1] (https://www.apache.org/dist/isis/archetype/simpleapp-archetype/simpleapp-archetype-1.15.1-source-release.zip.asc[asc], https://www.apache.org/dist/isis/archetype/simpleapp-archetype/simpleapp-archetype-1.15.1-source-release.zip.md5[md5]) +* https://www.apache.org/dyn/closer.cgi/isis/archetype/simpleapp-archetype/simpleapp-archetype-1.16.0-source-release.zip[simpleapp-archetype-1.16.0] (https://www.apache.org/dist/isis/archetype/simpleapp-archetype/simpleapp-archetype-1.16.0-source-release.zip.asc[asc], https://www.apache.org/dist/isis/archetype/simpleapp-archetype/simpleapp-archetype-1.16.0-source-release.zip.md5[md5]) @@ -50,7 +50,7 @@ Then verify the signatures using a command such as: [source,bash] ---- pgpk -a KEYS -pgpv isis-1.15.1-source-release.zip.asc isis-1.15.1-source-release.zip +pgpv isis-1.16.0-source-release.zip.asc isis-1.16.0-source-release.zip ---- or @@ -58,7 +58,7 @@ or [source,bash] ---- pgp -ka KEYS -pgp isis-1.15.1-source-release.zip.asc isis-1.15.1-source-release.zip +pgp isis-1.16.0-source-release.zip.asc isis-1.16.0-source-release.zip ---- or @@ -66,7 +66,7 @@ or [source,bash] ---- gpg –import KEYS -gpg -verify isis-1.15.1-source-release.zip.asc isis-1.15.1-source-release.zip +gpg -verify isis-1.16.0-source-release.zip.asc isis-1.16.0-source-release.zip ---- 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 743516a..b5a167a 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 @@ -311,7 +311,7 @@ If there are any snags at this stage, then explicitly delete the generated `rele [[__cgcom_cutting-a-release_releasing-core_post-prepare-sanity-check]] === Post-prepare sanity check -You should end up with artifacts in your local repo with the new version (eg `1.16.0`). This is a good time to do some quick sanity checks; nothing has yet been uploaded: +You should end up with artifacts in your local repo with the new version (eg `2.0.0-M1`). This is a good time to do some quick sanity checks; nothing has yet been uploaded: * unzip the source-release ZIP and check it builds. * Inspect the `DEPENDENCIES` file, and check it looks correct. @@ -371,17 +371,17 @@ The command checks out the codebase from the tag, then builds the artifacts, the [INFO] Performing a LOCAL checkout from scm:git:file:///C:\APACHE\isis-git-rw\co re [INFO] Checking out the project to perform the release ... -[INFO] Executing: cmd.exe /X /C "git clone --branch release-1.16.0 file:///C:\APACHE\isis-git-rw\core C:\APACHE\isis-git-rw\core\target\checkout" +[INFO] Executing: cmd.exe /X /C "git clone --branch release-2.0.0-M1 file:///C:\APACHE\isis-git-rw\core C:\APACHE\isis-git-rw\core\target\checkout" [INFO] Working directory: C:\APACHE\isis-git-rw\core\target [INFO] Performing a LOCAL checkout from scm:git:file:///C:\APACHE\isis-git-rw [INFO] Checking out the project to perform the release ... -[INFO] Executing: cmd.exe /X /C "git clone --branch release-1.16.0 file:///C:\APACHE\isis-git-rw C:\APACHE\isis-git-rw\core\target\checkout" +[INFO] Executing: cmd.exe /X /C "git clone --branch release-2.0.0-M1 file:///C:\APACHE\isis-git-rw C:\APACHE\isis-git-rw\core\target\checkout" [INFO] Working directory: C:\APACHE\isis-git-rw\core\target [INFO] Executing: cmd.exe /X /C "git ls-remote file:///C:\APACHE\isis-git-rw" [INFO] Working directory: C:\Users\ADMINI~1\AppData\Local\Temp [INFO] Executing: cmd.exe /X /C "git fetch file:///C:\APACHE\isis-git-rw" [INFO] Working directory: C:\APACHE\isis-git-rw\core\target\checkout -[INFO] Executing: cmd.exe /X /C "git checkout release-1.16.0" +[INFO] Executing: cmd.exe /X /C "git checkout release-2.0.0-M1" [INFO] Working directory: C:\APACHE\isis-git-rw\core\target\checkout [INFO] Executing: cmd.exe /X /C "git ls-files" [INFO] Working directory: C:\APACHE\isis-git-rw\core\target\checkout @@ -453,7 +453,7 @@ Update the parent `pom.xml` to reference the _released_ version of Apache Isis c [source,xml] ---- <properties> - <isis.version>1.16.0</isis.version> + <isis.version>2.0.0-M1</isis.version> ... </properties> ---- @@ -683,7 +683,7 @@ Update the parent `pom.xml` to reference the _released_ version of Apache Isis c [source,xml] ---- <properties> - <isis.version>1.16.0</isis.version> + <isis.version>2.0.0-M1</isis.version> ... </properties> ---- @@ -921,7 +921,7 @@ Use the following subject, eg: [source,bash] ---- -[VOTE] Apache Isis Core release 1.16.0 RC1 +[VOTE] Apache Isis Core release 2.0.0-M1 RC1 ---- And use the following body: @@ -930,19 +930,19 @@ And use the following body: ---- I've cut a release for Apache Isis Core and the two archetypes: -* Core 1.16.0 -* HelloWorld Archetype 1.16.0 -* SimpleApp Archetype 1.16.0 +* Core 2.0.0-M1 +* HelloWorld Archetype 2.0.0-M1 +* SimpleApp Archetype 2.0.0-M1 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/1.16.0/isis-1.16.0-source-release.zip -* http://repository.apache.org/content/repositories/orgapacheisis-10xx/org/apache/isis/archetype/helloworld-archetype/1.16.0/helloworld-archetype-1.16.0-source-release.zip -* http://repository.apache.org/content/repositories/orgapacheisis-10xx/org/apache/isis/archetype/simpleapp-archetype/1.16.0/simpleapp-archetype-1.16.0-source-release.zip +* http://repository.apache.org/content/repositories/orgapacheisis-10xx/org/apache/isis/core/isis/2.0.0-M1/isis-2.0.0-M1-source-release.zip +* http://repository.apache.org/content/repositories/orgapacheisis-10xx/org/apache/isis/archetype/helloworld-archetype/2.0.0-M1/helloworld-archetype-2.0.0-M1-source-release.zip +* http://repository.apache.org/content/repositories/orgapacheisis-10xx/org/apache/isis/archetype/simpleapp-archetype/2.0.0-M1/simpleapp-archetype-2.0.0-M1-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-1.16.0-RC1, helloworld-archetype-1.16.0-RC1 and simpleapp-archetype-1.16.0-RC1; see https://github.com/apache/isis/tags +In the source code repo the code has been tagged as isis-2.0.0-M1-RC1, helloworld-archetype-2.0.0-M1-RC1 and simpleapp-archetype-2.0.0-M1-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 @@ -955,7 +955,7 @@ Please verify the release and cast your vote. The vote will be open for a minim Remember to update: -* the version number (1.16.0 or whatever) +* the version number (`2.0.0-M1` 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 8f777d4..ffe6e87 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 @@ -26,7 +26,7 @@ Post the results to the `[email protected]` mailing list: [source,bash] ---- -[RESULT] [VOTE] Apache Isis Core release 1.16.0 +[RESULT] [VOTE] Apache Isis Core release 2.0.0-M1 ---- using the body (alter last line as appropriate): @@ -56,9 +56,9 @@ You can do this using the `scripts/promoterctag.sh` script; for example: [source,bash] ---- -sh scripts/promoterctag.sh isis-1.16.0 RC1 -sh scripts/promoterctag.sh helloworld-archetype-1.16.0 RC1 -sh scripts/promoterctag.sh simpleapp-archetype-1.16.0 RC1 +sh scripts/promoterctag.sh isis-2.0.0-M1 RC1 +sh scripts/promoterctag.sh helloworld-archetype-2.0.0-M1 RC1 +sh scripts/promoterctag.sh simpleapp-archetype-2.0.0-M1 RC1 ---- This script pushes the tag under `refs/tags/rel`. As per Apache policy (communicated on 10th Jan 2016 to Apache PMCs), @@ -189,7 +189,7 @@ popd [source,bash] ---- -sh upd.sh 1.15.1 1.16.0 +sh upd.sh 1.16.0 2.0.0-M1 ---- The script downloads the artifacts from the Nexus release repository, adds the artifacts to subversion and deletes the previous version. @@ -223,7 +223,7 @@ From the root directory, generate the release notes for the current release, in [source,bash] ---- -sh scripts/jira-release-notes.sh ISIS 1.16.0 > /tmp/1 +sh scripts/jira-release-notes.sh ISIS 2.0.0-M1 > /tmp/1 ---- @@ -254,7 +254,7 @@ Log the new release in the link:https://reporter.apache.org/addrelease.html?isis == Update website -Update the Apache Isis (asciidoc) website: +In the main `isis` repo (ie containing the asciidoc source): * Paste in the JIRA-generated release notes generated above, adding to top of `adocs/documentation/src/main/asciidoc/release-notes.adoc`. Also add a summary line for the release. @@ -274,11 +274,45 @@ Validate using the http://www.w3.org/RDF/Validator/[W3C RDF Validator] service. + For more information on DOAP files, see these http://projects.apache.org/doap.html[Apache policy docs]. -* Update the https://github.com/apache/isis/blob/master/STATUS[STATUS] file (in root of Apache Isis' source) should be updated with details of the new release. +* Update the https://git-wip-us.apache.org/repos/asf/isis/repo?p=isis.git;a=blob_plain;f=STATUS;hb=HEAD[STATUS] file (in root of Apache Isis' source) should be updated with details of the new release. +* commit the `.adoc` changes and publish to the `isis-site` repo. -Don't forget to commit the `.adoc` changes and publish to the isis-site repo. +This will have published to the `SNAPSHOT` directory of the `isis-site` repo. +Now, in the `isis-site` repo itself: +* double check that a copy of current exists as a named directory under `content/versions` + ++ +If for any reason it isn't there, then create a copy. + +* delete the current version and rename `SNAPSHOT` as `current`: + ++ +[source,bash] +---- +rm -rf content/versions/current +mv content/versions/SNAPSHOT content/versions/current +---- + +* take a copy of the new `current` version as a named version: + ++ +For example: ++ +[source,bash] +---- +cp -rf content/versions/current content/versions/2.0.0-M1 +---- + +* In the root `index.html`, update the menu to reference the new version. + +At this point the files in the root (directly under `content`) will still be out of date; the publish process simply takes a copy of whatever is in `content/versions/current`. +Also, the `SNAPSHOT` will be missing (above it was renamed to `current`). +To fix this, simply publish the website one more time (from the `isis` main repo). + +Finally, preview the changes (in the `isis-site`). +If everything looks ok, then push the changes to make live. @@ -290,14 +324,14 @@ For example, for a release of Apache Isis Core, use the following subject: [source,bash] ---- -[ANN] Apache Isis version 1.16.0 Released +[ANN] Apache Isis version 2.0.0-M1 Released ---- And use the following body (summarizing the main points as required): [source] ---- -The Apache Isis team is pleased to announce the release of Apache Isis v1.16.0. +The Apache Isis team is pleased to announce the release of Apache Isis v2.0.0-M1. New features in this release include: * ... @@ -312,8 +346,8 @@ Enjoy! --The Apache Isis team -[1] http://isis.apache.org/release-notes/release-notes.html#_release-notes_1.16.0 -[2] http://isis.apache.org/migration-notes/migration-notes.html#_migration-notes_1.15.0-to-1.16.0 +[1] http://isis.apache.org/release-notes/release-notes.html#_release-notes_2.0.0-M1 +[2] http://isis.apache.org/migration-notes/migration-notes.html#_migration-notes_1.16.0-to-2.0.0-M1 [3] http://search.maven.org [4] http://isis.apache.org/downloads.html ---- @@ -338,9 +372,9 @@ Because we release from a branch, the changes made in the branch (changes to `po ---- git checkout master # update master with latest git pull -git merge release-1.16.0-RC1 # merge branch onto master -git push origin --delete release-1.16.0-RC1 # remote branch no longer needed -git branch -d release-1.16.0-RC1 # branch no longer needed +git merge release-2.0.0-M1-RC1 # merge branch onto master +git push origin --delete release-2.0.0-M1-RC1 # remote branch no longer needed +git branch -d release-2.0.0-M1-RC1 # branch no longer needed ---- 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 4359374..2d56862 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 @@ -25,7 +25,7 @@ For example, use the following subject for a vote on Apache Isis Core: [source,bash] ---- -[RESULT] [VOTE] Apache Isis Core release 1.16.0 +[RESULT] [VOTE] Apache Isis Core release 2.0.0-M1 ---- using the body (alter last line as appropriate): @@ -52,7 +52,7 @@ Tidy up remote branches in the git repo: + [source,bash] ---- -git push --delete origin release-1.16.0-RC1 +git push --delete origin release-2.0.0-M1-RC1 ---- @@ -60,9 +60,9 @@ git push --delete origin release-1.16.0-RC1 + [source,bash] ---- -git push --delete origin isis-1.16.0-RC1 -git push --delete origin helloworld-archetype-1.16.0-RC1 -git push --delete origin simpleapp-archetype-1.16.0-RC1 +git push --delete origin isis-2.0.0-M1-RC1 +git push --delete origin helloworld-archetype-2.0.0-M1-RC1 +git push --delete origin simpleapp-archetype-2.0.0-M1-RC1 ---- @@ -70,9 +70,9 @@ git push --delete origin simpleapp-archetype-1.16.0-RC1 + [source,bash] ---- -git tag -d isis-1.16.0 -git tag -d helloworld-archetype-1.16.0 -git tag -d simpleapp-archetype-1.16.0 +git tag -d isis-2.0.0-M1 +git tag -d helloworld-archetype-2.0.0-M1 +git tag -d simpleapp-archetype-2.0.0-M1 ---- 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 b021fa7..07da28c 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 @@ -231,7 +231,7 @@ Assuming that everything builds ok, then test the archetypes (adjust version as mvn archetype:generate \ -D archetypeGroupId=org.apache.isis.archetype \ -D archetypeArtifactId=helloworld-archetype \ - -D archetypeVersion=1.16.0 \ + -D archetypeVersion=2.0.0-M1 \ -D groupId=com.mycompany \ -D artifactId=myapp \ -D version=1.0-SNAPSHOT \ @@ -251,7 +251,7 @@ Adjust the version as necessary. mvn archetype:generate \ -D archetypeGroupId=org.apache.isis.archetype \ -D archetypeArtifactId=simpleapp-archetype \ - -D archetypeVersion=1.16.0 \ + -D archetypeVersion=2.0.0-M1 \ -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_helloworld-archetype.adoc b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_helloworld-archetype.adoc index 7765bd0..5ff2576 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 @@ -33,7 +33,7 @@ To build the app from the latest stable release, then run the following command: mvn archetype:generate \ -D archetypeGroupId=org.apache.isis.archetype \ -D archetypeArtifactId=helloworld-archetype \ - -D archetypeVersion=1.15.1 \ + -D archetypeVersion=1.16.0 \ -D groupId=com.mycompany \ -D artifactId=myapp \ -D version=1.0-SNAPSHOT \ diff --git a/adocs/documentation/src/main/asciidoc/pages/tg/_tg_stop-scaffolding-start-coding.adoc b/adocs/documentation/src/main/asciidoc/pages/tg/_tg_stop-scaffolding-start-coding.adoc index f4ef91d..0e6c42c 100644 --- a/adocs/documentation/src/main/asciidoc/pages/tg/_tg_stop-scaffolding-start-coding.adoc +++ b/adocs/documentation/src/main/asciidoc/pages/tg/_tg_stop-scaffolding-start-coding.adoc @@ -33,7 +33,7 @@ With the *nix bash shell, use: mvn archetype:generate \ -D archetypeGroupId=org.apache.isis.archetype \ -D archetypeArtifactId=simpleapp-archetype \ - -D archetypeVersion=1.15.1 \ + -D archetypeVersion=1.16.0 \ -D groupId=com.mycompany \ -D artifactId=myapp \ -D version=1.0-SNAPSHOT \ diff --git a/adocs/documentation/src/main/asciidoc/release-notes/release-notes.adoc b/adocs/documentation/src/main/asciidoc/release-notes/release-notes.adoc index 6c09af3..5cd74c3 100644 --- a/adocs/documentation/src/main/asciidoc/release-notes/release-notes.adoc +++ b/adocs/documentation/src/main/asciidoc/release-notes/release-notes.adoc @@ -22,7 +22,7 @@ This table summarises all releases of Apache Isis to date. | JIRA relnotes | xref:release-notes.adoc#_release-notes_1.16.0[1.16.0] -| XX-XX-2018 +| 08-01-2018 | Modules, simplified bootstrapping, menubars.layout.xml | 13 | 16 -- To stop receiving notification emails like this one, please contact "[email protected]" <[email protected]>.
