[plc4x] 02/02: - Added some checklists to the release and validation documentation

[cd...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

cdutz pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/plc4x.git

commit 685e7464aecf212553f65a5f9606b7cf5a0900bc
Author: Christofer Dutz <ch...@c-ware.de>
AuthorDate: Tue Feb 18 11:37:56 2020 +0100

    - Added some checklists to the release and validation documentation
---
 src/site/asciidoc/developers/release/release.adoc  | 38 +++++++++++++++++++
 .../asciidoc/developers/release/validation.adoc    | 44 +++++++++++-----------
 2 files changed, 60 insertions(+), 22 deletions(-)

diff --git a/src/site/asciidoc/developers/release/release.adoc b/src/site/asciidoc/developers/release/release.adoc
index 5b43077..bb2117e 100644
--- a/src/site/asciidoc/developers/release/release.adoc
+++ b/src/site/asciidoc/developers/release/release.adoc
@@ -19,6 +19,44 @@
 
 == Releasing PLC4X
 
+=== TL/DR
+
+IMPORTANT: Please be sure to execute the release with a Java version between 1.8 and 11 or the Karaf feature tests will not run.
+
+[%interactive]
+* [ ] Update the `RELEASE_NOTES`
+* [ ] Check year in `NOTICE`
+* [ ] Create release branch:
+[subs="verbatim,attributes"]
+----
+   mvn release:branch -P with-sandbox,with-cpp,with-boost,with-dotnet,with-python,with-proxies,with-logstash -DbranchName=rel/{current-short-version} -DautoVersionSubmodules=true
+----
+[%interactive]
+* [ ] Add a new section to the `RELEASE_NOTES` on `develop`
+* [ ] Prepare the release:
+[subs="verbatim,attributes"]
+----
+   mvn release:prepare -P with-sandbox,with-cpp,with-boost,with-dotnet,with-python,with-proxies,with-logstash -DautoVersionSubmodules=true
+----
+[%interactive]
+* [ ] Perform the release:
+[subs="verbatim,attributes"]
+----
+   mvn release:perform -DreleaseProfiles=apache-release,with-boost,with-proxies,with-logstash
+----
+[%interactive]
+* [ ] Close the staging repo on `Nexus`
+* [ ] Stage the release artifacts in `SVN`
+* [ ] Vote on the mailing list
+* [ ] Move RC to the release section of `SVN`
+* [ ] Remove old releases in `SVN`
+* [ ] Release staging repo on `Nexus`
+* [ ] Add the version to the DOAP file on `develop`
+* [ ] Update Download site
+* [ ] Update Jira
+* [ ] Merge back release version to `master` branch
+* [ ] Send announce email
+
 === Preparing your system for being able to release
 
 As part of the release process, Maven will upload maven release artifacts to a so-called staging repository.
diff --git a/src/site/asciidoc/developers/release/validation.adoc b/src/site/asciidoc/developers/release/validation.adoc
index f96a3b1..8e90c3c 100644
--- a/src/site/asciidoc/developers/release/validation.adoc
+++ b/src/site/asciidoc/developers/release/validation.adoc
@@ -21,46 +21,46 @@
 
 TIP: On MacOS and Linux the first 4 steps can be automated. For details please read the section about tooling after this chapter.
 
-1. Download all staged artifacts under the url specified in the release vote email into a directory we'll now call `download-dir`.
-2. Verify the signature is correct:
+[%interactive]
+* [ ] Download all staged artifacts under the url specified in the release vote email into a directory we'll now call `download-dir`.
+* [ ] Verify the signature is correct:
 Additional Apache tutorial on how to verify downloads can be found http://www.apache.org/info/verification.html[here].
-+
 [subs="attributes"]
 ----
 gpg --verify apache-plc4x-{current-full-version}-source-release.zip.asc apache-plc4x-#{current-full-version}-source-release.zip
 ----
-+
-3. Check if the check is successful.
-4. Check if the signature references an Apache email address.
-5. Verify the SHA512 hashes:
-+
+[%interactive]
+* [ ] Check if the check is successful.
+* [ ] Check if the signature references an Apache email address.
+* [ ] Verify the SHA512 hashes:
 [subs="attributes"]
 ----
 shasum -a512 apache-plc4x-{current-full-version}-source-release.zip
 ----
-+
-6. Unzip the archive:
-+
+[%interactive]
+* [ ] Unzip the archive:
 [subs="attributes"]
 ----
 unzip apache-plc4x-{current-full-version}-source-release.zip
 ----
-+
-7. Verify the existence of `LICENSE`, `NOTICE, `README`, `RELEASE_NOTES` files in the extracted source bundle.
-8. Verify the content of `LICENSE`, `NOTICE`, `README`, `RELEASE_NOTES files in the extracted source bundle.
-** (Especially pay attention to the year in the `NOTICE` file if this is the first release of the year)
-9. [RM] Verify the staged source README, RELEASE_NOTE files correspond to those in the extracted source bundle.
-10. [RM] Run RAT externally to ensure there are no surprises.
+[%interactive]
+* [ ] Verify the existence of `LICENSE`, `NOTICE`, `README`, `RELEASE_NOTES` files in the extracted source bundle.
+* [ ] Verify the content of `LICENSE`, `NOTICE`, `README`, `RELEASE_NOTES` files in the extracted source bundle.
+
+TIP: (Especially pay attention to the year in the `NOTICE` file if this is the first release of the year)
+
+[%interactive]
+* [ ] [RM] Verify the staged source README, RELEASE_NOTE files correspond to those in the extracted source bundle.
+* [ ] [RM] Run RAT externally to ensure there are no surprises.
 ** TODO: Document this.
-11. Search for `SNAPSHOT` references:
-+
+* [ ] Search for `SNAPSHOT` references:
 [subs="attributes"]
 ----
 find . -type f -name 'pom.xml' -exec grep -l "SNAPSHOT" {} \;
 ----
-+
-12. Build the project according to the information in the README.md file.
-** [RM] Build the project with all `with-xyz` profiles and tests enabled and an empty maven local repo: by appendng `-Dmaven.repo.local=../.m2`.
+[%interactive]
+* [ ] Build the project according to the information in the README.md file.
+* [ ] [RM] Build the project with all `with-xyz` profiles and tests enabled and an empty maven local repo: by appendng `-Dmaven.repo.local=../.m2`.
 
 === Release Tooling