ISIS-1335: doc updates to release process for 1.13.0
Project: http://git-wip-us.apache.org/repos/asf/isis/repo Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/1fbb597c Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/1fbb597c Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/1fbb597c Branch: refs/heads/master Commit: 1fbb597cf0d779d5b7f93af2984bb574e27a6adb Parents: 5361062 Author: Dan Haywood <d...@haywood-associates.co.uk> Authored: Mon Mar 28 11:07:33 2016 +0100 Committer: Dan Haywood <d...@haywood-associates.co.uk> Committed: Tue Mar 29 09:11:28 2016 +0100 ---------------------------------------------------------------------- .../guides/_cgcom_cutting-a-release.adoc | 34 ++++++++++---------- .../guides/_cgcom_post-release-successful.adoc | 32 +++++++++--------- .../_cgcom_post-release-unsuccessful.adoc | 16 ++++----- .../guides/_cgcom_verifying-releases.adoc | 2 +- 4 files changed, 42 insertions(+), 42 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/isis/blob/1fbb597c/adocs/documentation/src/main/asciidoc/guides/_cgcom_cutting-a-release.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/_cgcom_cutting-a-release.adoc b/adocs/documentation/src/main/asciidoc/guides/_cgcom_cutting-a-release.adoc index 8f581e0..2a52740 100644 --- a/adocs/documentation/src/main/asciidoc/guides/_cgcom_cutting-a-release.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/_cgcom_cutting-a-release.adoc @@ -47,8 +47,8 @@ We use environment variables to parameterize as many of the steps as possible. ---- cd core export ISISTMP=/c/tmp # <1> -export ISISDEV=1.13.0-SNAPSHOT -export ISISREL=1.12.0 +export ISISDEV=1.14.0-SNAPSHOT +export ISISREL=1.13.0 export ISISRC=RC1 export ISISBRANCH=release-$ISISREL-$ISISRC export ISISJIRA=ISIS-9999 # <2> @@ -62,7 +62,7 @@ Obviously, alter `$ISISDEV` and `$ISISREL` as required, and bump `$ISISRC` for r [IMPORTANT] ==== -Note that the branch name is *not* the same any of the eventual tag names (eg `isis-1.12.0` or `simpleapp-archetype-1.12.0`). +Note that the branch name is *not* the same any of the eventual tag names (eg `isis-1.13.0` or `simpleapp-archetype-1.13.0`). If they did have the same name, then what would happen is that the `maven-release-plugin` would checkout the (HEAD of the) branch and thus upload a SNAPSHOT to the snapshot repository. What it should of course do is checkout the tag and then upload that to the release staging repository. ==== @@ -86,13 +86,13 @@ All release preparation is done locally; if we are successful, this branch will Double check that the version number of the parent pom should reflect the branch name that you are now on (with a `-SNAPSHOT` suffix). his will normally have been done already during earlier development; but confirm that it has been updated. 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 `1.12.0`, the POM should read: +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 `1.13.0`, the POM should read: [source,xml] ---- <groupId>org.apache.isis.core</groupId> <artifactId>isis</artifactId> -<version>1.12.0-SNAPSHOT</version> +<version>1.13.0-SNAPSHOT</version> ---- Also, check that there are no snapshot dependencies: @@ -282,7 +282,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.12.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 `1.13.0`). 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. @@ -338,17 +338,17 @@ The custom `workingDirectory` prevents file path issues if releasing on Windows. [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.12.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-1.13.0 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.12.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-1.13.0 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.12.0" +[INFO] Executing: cmd.exe /X /C "git checkout release-1.13.0" [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 @@ -401,7 +401,7 @@ Update the parent `pom.xml` to reference the _released_ version of Apache Isis c [source,xml] ---- <properties> - <isis.version>1.12.0</isis.version> + <isis.version>1.13.0</isis.version> ... </properties> ---- @@ -637,7 +637,7 @@ Use the following subject, eg: [source,bash] ---- -[VOTE] Apache Isis Core release 1.12.0 RC1 +[VOTE] Apache Isis Core release 1.13.0 RC1 ---- And use the following body: @@ -646,17 +646,17 @@ And use the following body: ---- I've cut a release for Apache Isis Core and the simpleapp archetype: -* Core 1.12.0 -* SimpleApp Archetype 1.12.0 +* Core 1.13.0 +* SimpleApp Archetype 1.13.0 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.12.0/isis-1.12.0-source-release.zip -* http://repository.apache.org/content/repositories/orgapacheisis-10xx/org/apache/isis/archetype/simpleapp-archetype/1.12.0/simpleapp-archetype-1.12.0-source-release.zip +* http://repository.apache.org/content/repositories/orgapacheisis-10xx/org/apache/isis/core/isis/1.13.0/isis-1.13.0-source-release.zip +* http://repository.apache.org/content/repositories/orgapacheisis-10xx/org/apache/isis/archetype/simpleapp-archetype/1.13.0/simpleapp-archetype-1.13.0-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.12.0-RC1 and simpleapp-archetype-1.12.0-RC1; see https://git-wip-us.apache.org/repos/asf?p=isis.git +In the source code repo the code has been tagged as isis-1.13.0-RC1 and simpleapp-archetype-1.13.0-RC1; see https://git-wip-us.apache.org/repos/asf?p=isis.git For instructions on how to verify the release (build from binaries and/or use in Maven directly), see http://isis.apache.org/guides/cgcom.html#_cgcom_verifying-releases @@ -669,7 +669,7 @@ Please verify the release and cast your vote. The vote will be open for a minim Remember to update: -* the version number (1.12.0 or whatever) +* the version number (1.13.0 or whatever) * the release candidate number (`RC1` or whatever) * the repository id, as provided by Nexus earlier (`orgapacheisis-10xx` or whatever) http://git-wip-us.apache.org/repos/asf/isis/blob/1fbb597c/adocs/documentation/src/main/asciidoc/guides/_cgcom_post-release-successful.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/_cgcom_post-release-successful.adoc b/adocs/documentation/src/main/asciidoc/guides/_cgcom_post-release-successful.adoc index 51294e3..4cb9ee2 100644 --- a/adocs/documentation/src/main/asciidoc/guides/_cgcom_post-release-successful.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/_cgcom_post-release-successful.adoc @@ -25,7 +25,7 @@ Post the results to the `dev@isis.a.o` mailing list: [source,bash] ---- -[RESULT] [VOTE] Apache Isis Core release 1.12.0 +[RESULT] [VOTE] Apache Isis Core release 1.13.0 ---- using the body (alter last line as appropriate): @@ -53,8 +53,8 @@ You can do this using the `scripts/promoterctag.sh` script; for example: [source,bash] ---- -sh scripts/promoterctag.sh isis-1.12.0 RC1 -sh scripts/promoterctag.sh simpleapp-archetype-1.12.0 RC1 +sh scripts/promoterctag.sh isis-1.13.0 RC1 +sh scripts/promoterctag.sh simpleapp-archetype-1.13.0 RC1 ---- This script pushes the tag under `refs/tags/rel`. As per Apache policy (communicated on 10th Jan 2016 to Apache PMCs), @@ -159,7 +159,7 @@ popd [source,bash] ---- -sh upd.sh 1.11.0 1.12.0 +sh upd.sh 1.12.0 1.13.0 ---- The script downloads the artifacts from the Nexus release repository, adds the artifacts to subversion and deletes the previous version. @@ -192,7 +192,7 @@ From the root directory, generate the release notes for the current release, in [source,bash] ---- -sh scripts/jira-release-notes.sh ISIS 1.12.0 > /tmp/1 +sh scripts/jira-release-notes.sh ISIS 1.13.0 > /tmp/1 ---- @@ -257,14 +257,14 @@ For example, for a release of Apache Isis Core, use the following subject: [source,bash] ---- -[ANN] Apache Isis version 1.12.0 Released +[ANN] Apache Isis version 1.13.0 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.12.0. +The Apache Isis team is pleased to announce the release of Apache Isis v1.13.0. New features in this release include: * ... @@ -278,8 +278,8 @@ Enjoy! --The Apache Isis team -[1] http://isis.apache.org/release-notes.html#r1.12.0 -[2] http://isis.apache.org/migration-notes.html#_migration-notes_1.11.0-to-1.12.0 +[1] http://isis.apache.org/release-notes.html#r1.13.0 +[2] http://isis.apache.org/migration-notes.html#_migration-notes_1.12.0-to-1.13.0 [3] http://search.maven.org [4] http://isis.apache.org/downloads.html ---- @@ -303,13 +303,13 @@ 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.12.0-RC1 # merge branch onto master -git branch -d release-1.12.0-RC1 # branch no longer needed -git push origin --delete release-1.12.0-RC1 # remote branch no longer needed +git merge release-1.13.0-RC1 # merge branch onto master +git branch -d release-1.13.0-RC1 # branch no longer needed +git push origin --delete release-1.13.0-RC1 # remote branch no longer needed ---- -Finally, update the simpleapp's root `pom.xml` to reference the next SNAPSHOT release (`1.12.0-SNAPSHOT`) +Finally, update the simpleapp's root `pom.xml` to reference the next SNAPSHOT release (`1.13.0-SNAPSHOT`) @@ -413,7 +413,7 @@ Using this https://gist.github.com/danhaywood/ff17946ee05652402cfb[gist] to invo + [source,bash] ---- -sh forsub.sh sh bumpver_isis.sh 1.12.0 +sh forsub.sh sh bumpver_isis.sh 1.13.0 ---- * update the README for each repository @@ -426,13 +426,13 @@ sh forsub.sh sh bumpver_isis.sh 1.12.0 + [source,bash] ---- -sh forsub.sh sh release.sh "1.12.0" "1.13.0-SNAPSHOT" "d...@haywood-associates.co.uk" \"this is not really my password\" +sh forsub.sh sh release.sh "1.13.0" "1.14.0-SNAPSHOT" "d...@haywood-associates.co.uk" \"this is not really my password\" ---- * update its dependency on Apache Isis to reference the next SNAPSHOT version: + + [source,bash] ---- -sh forsub.sh sh bumpver_isis.sh "1.13.0-SNAPSHOT" +sh forsub.sh sh bumpver_isis.sh "1.14.0-SNAPSHOT" ---- http://git-wip-us.apache.org/repos/asf/isis/blob/1fbb597c/adocs/documentation/src/main/asciidoc/guides/_cgcom_post-release-unsuccessful.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/_cgcom_post-release-unsuccessful.adoc b/adocs/documentation/src/main/asciidoc/guides/_cgcom_post-release-unsuccessful.adoc index 4a4bd64..c3a24de 100644 --- a/adocs/documentation/src/main/asciidoc/guides/_cgcom_post-release-unsuccessful.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/_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.12.0 +[RESULT] [VOTE] Apache Isis Core release 1.13.0 ---- 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.12.0-RC1 +git push --delete origin release-1.13.0-RC1 ---- @@ -60,8 +60,8 @@ git push --delete origin release-1.12.0-RC1 + [source,bash] ---- -git push --delete origin isis-1.12.0-RC1 -git push --delete origin simpleapp-archetype-1.12.0-RC1 +git push --delete origin isis-1.13.0-RC1 +git push --delete origin simpleapp-archetype-1.13.0-RC1 ---- @@ -69,10 +69,10 @@ git push --delete origin simpleapp-archetype-1.12.0-RC1 + [source,bash] ---- -git tag -d isis-1.12.0 -git tag -d isis-1.12.0-RC1 -git tag -d simpleapp-archetype-1.12.0 -git tag -d simpleapp-archetype-1.12.0-RC1 +git tag -d isis-1.13.0 +git tag -d isis-1.13.0-RC1 +git tag -d simpleapp-archetype-1.13.0 +git tag -d simpleapp-archetype-1.13.0-RC1 ---- http://git-wip-us.apache.org/repos/asf/isis/blob/1fbb597c/adocs/documentation/src/main/asciidoc/guides/_cgcom_verifying-releases.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/_cgcom_verifying-releases.adoc b/adocs/documentation/src/main/asciidoc/guides/_cgcom_verifying-releases.adoc index f07ed58..4784e68 100644 --- a/adocs/documentation/src/main/asciidoc/guides/_cgcom_verifying-releases.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/_cgcom_verifying-releases.adoc @@ -285,7 +285,7 @@ mvn archetype:generate \ -D version=1.0-SNAPSHOT \ -B \ -o \ - -D archetypeVersion=1.12.0 # adjust version as necessary + -D archetypeVersion=1.13.0 # adjust version as necessary cd myapp mvn clean install -o
