You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tamaya.apache.org by pl...@apache.org on 2017/08/26 09:55:53 UTC
[01/16] incubator-tamaya-site git commit: Update docs [Forced Update!]
Repository: incubator-tamaya-site
Updated Branches:
refs/heads/overhauling-release-guide 6e2d76a3f -> 3acfb6016 (forced update)
Update docs
Fix broken deprecated link.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/commit/1391ae8e
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/tree/1391ae8e
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/diff/1391ae8e
Branch: refs/heads/overhauling-release-guide
Commit: 1391ae8ec9436278c756ccb39af3a62018311673
Parents: 73ee538
Author: Phil Ottlinger <po...@apache.org>
Authored: Mon Aug 7 21:49:26 2017 +0200
Committer: Phil Ottlinger <po...@apache.org>
Committed: Mon Aug 7 21:49:26 2017 +0200
----------------------------------------------------------------------
README.md | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/1391ae8e/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index ef1cde1..b1bc111 100644
--- a/README.md
+++ b/README.md
@@ -82,12 +82,13 @@ $ ./copy-site.sh
$ git checkout asf-site
$ cp -r pathToTamayaCoreRepo/target/site/apidocs .
```
+1. If you do not want to change the already published Javadoc, make sure that your commit does not change the base index.html, that renders https://tamaya.incubator.apache.org/apidocs/index.html
1. Push your changes
```
$ git push
```
1. Wait a couple of minutes for the gitpubsub to happen.
-1. Go to https://tamaya.incubator.apache.org/jbake/ in your browser
+1. Go to https://tamaya.incubator.apache.org/ in your browser
#### Jenkins / CI integration
[07/16] incubator-tamaya-site git commit: Overhauled the section
'Check everything is ready'.
Posted by pl...@apache.org.
Overhauled the section 'Check everything is ready'.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/commit/d31fc258
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/tree/d31fc258
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/diff/d31fc258
Branch: refs/heads/overhauling-release-guide
Commit: d31fc25856da6a4d056add8a9aee2e1eb10940ff
Parents: 46d2b71
Author: Oliver B. Fischer <pl...@apache.org>
Authored: Sat Jul 1 12:41:51 2017 +0200
Committer: Oliver B. Fischer <pl...@apache.org>
Committed: Sat Aug 26 11:54:47 2017 +0200
----------------------------------------------------------------------
content/release-guide.adoc | 27 ++++++++++++++++++---------
1 file changed, 18 insertions(+), 9 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/d31fc258/content/release-guide.adoc
----------------------------------------------------------------------
diff --git a/content/release-guide.adoc b/content/release-guide.adoc
index 5b8cc26..332c1de 100644
--- a/content/release-guide.adoc
+++ b/content/release-guide.adoc
@@ -63,19 +63,28 @@ Don't expect that everyone will response immediately as we all are very
busy. So be patient with you team members. Meanwhile you can
proceed with the release preparations.
+=== Check if everything is ready
+
+The following items must be done before you can start with the
+actual release process.
+
+. Check if the build chains
+ https://builds.apache.org/view/Tamaya/[Apache's Jenkins^]
+ of the project in to be released are fine and where are
+ no problems with the build and quality of the project.
+. Ensure that all
+ https://issues.apache.org/jira/projects/TAMAYA[JIRA^] issues
+ targeting the upcomming release are resolved.
+ If not, get in contact with the issue assignee or the reporter to
+ check
+ .. if the issue can be postponed for the next release
+ .. how long it takes to resolve it and if someone can help.
---
-Rewritten until here
----
-
-== Check everything is ready
-* Check the jenkins builds.
-* Ensure all JIRA-tickets targeting the release are resolved. If not, get in contact with the ticket
- owner/assignee to check
- ** if the ticket can be postponed for the next release
- ** how long it takes to resolve it and if one can help.
+Rewritten until here
+---
== Prepare the release
[16/16] incubator-tamaya-site git commit: Wrote the section 'Let the
IPMC vote on the release candidate'
Posted by pl...@apache.org.
Wrote the section 'Let the IPMC vote on the release candidate'
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/commit/cb92dd66
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/tree/cb92dd66
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/diff/cb92dd66
Branch: refs/heads/overhauling-release-guide
Commit: cb92dd665533f1bfb97c8130bf5852eadb2d6d11
Parents: d7b4192
Author: Oliver B. Fischer <pl...@apache.org>
Authored: Sat Aug 12 22:39:48 2017 +0200
Committer: Oliver B. Fischer <pl...@apache.org>
Committed: Sat Aug 26 11:54:47 2017 +0200
----------------------------------------------------------------------
content/release-guide.adoc | 118 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 118 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/cb92dd66/content/release-guide.adoc
----------------------------------------------------------------------
diff --git a/content/release-guide.adoc b/content/release-guide.adoc
index 1d373b6..542b23c 100644
--- a/content/release-guide.adoc
+++ b/content/release-guide.adoc
@@ -418,6 +418,124 @@ After the vote on the PPMC has been finished and is successful,
repeat the voting process on the incubator mailing list.
+=== Let the IPMC vote on the release candidate
+
+During the incubation phase of Tamaya, each release must be approved
+by the IPMC.
+
+The first step is to subscribe to the mailinglist
+general@incubator.apache.org.
+More information and how to do this can be found on
+https://incubator.apache.org/guides/lists.html[^].
+
+:x: https://lists.apache.org/list.html?dev@tamaya.apache.org
+
+The mail, which must be send to the list, is quite similar
+to the one for the PPMC, but it must also contain a link
+to the mail thread of the successful vote of the PPMC.
+The archive of the developers mailinglist of Apache Tamaya
+can be found at https://lists.apache.org[^].
+
+The mail to the IPMC can be composed by using these both
+templates:
+
+[listing,text]
+.Subject of the vote on the release candidate
+----
+[Vote] Release of [project] [version] <1> <2>
+----
+<1> Replace _project_ by either Apache Tamaya API&Core or Apache Tamaya Extensions
+<2> Replace _version_ by the version number of the release
+
+[listing,text]
+.Body of the vote on the release candidate
+----
+[VOTE] Release of [project] [version] <1> <2>
+
+Dear IPMC members,
+
+The Apache Tamaya project was running the needed tasks to get
+the [version] release of [project] out. <1> <2>
+
+The artifacts available via the Apache distribution repository [1] and
+also via Apache's Nexus [2].
+
+The tag for this release candidate is available at [3]
+
+The mail thread of the vote can be found at [4].
+
+Please take a look at the artifacts and vote!
+
+Please note:
+This vote is a "majority approval" with a minimum of three +1 votes (see [5]).
+
+------------------------------------------------
+[ ] +1 for IPMC members who approve this release
+[ ] +0 for IPMC members with no opinion on this release
+[ ] -1 for IPMC members who reject this release, and why ...
+------------------------------------------------
+
+Thanks,
+[name]
+
+[1] [link to the source distribution] <3>
+[2] [link to the staging repository at Apache's Nexus] <4>
+[3] [link to the tag in the Git repository] <5>
+[4] [link to the thread of the vote by the PPMC.] <6>
+[5] http://www.apache.org/foundation/voting.html#ReleaseVotes
+----
+<1> Replace _project_ by the name of the project to be release, which can be
+ _Apache Tamaya API&Core_ or _Apache Tamaya Extensions_.
+<2> Replease _version_ by the version number of the intended release.
+<3> Insert here the link to the source distribution of the project
+ in the dev section of distribution repository
+ at https://dist.apache.org/repos/dist/dev/incubator/tamaya/[^].
+<4> Insert here the link to the staging repository for the release candidate
+ at http://repository.apache.org/content/repositories[^].
+<5> Insert here the link to the tag created for the release candidate
+ in the Git repository.
+<6> Insert here the link to vote thread on Tamaya's developer mailinglist
+ for this release candidate
+
+Send the mail to pass:macro[general@incubator.apache.org] and let
+the vote run for at least 72 hours.
+
+To close the vote count all single votes and send the result as reply
+to your initial mail to the mailinglist by using the templates below:
+
+[listing,text]
+.Subject of the mail with the result of the vote
+----
+[Result] (was: Re: [VOTE] Release of [project] [version]) <1> <2>
+----
+<1> Replace _project_ by the name of the project to be release, which can be
+ _Apache Tamaya API&Core_ or _Apache Tamaya Extensions_.
+<2> Replease _version_ by the version number of the intended release.
+
+[listing,text]
+.Body of the mail with the result of the vote
+----
+Thank you for voting!
+
+X binding +1 votes (PPMC): <1>
+[list] <2>
+
+Y non-binding +1 votes: <3>
+[list] <4>
+
+Z -1 votes: <5>
+[list] <6>
+----
+<1> Replace _X_ by the number of positive votes by IPMC members
+<2> Replace _list_ by the names of IPMC members with a positive vote
+<3> Replace _Y_ by the number of non-binding positive votes by
+ non-IPMC members
+<4> Replace _list_ by the names of non-PPMC members with a positive vote
+<5> Replace _Z_ by the number of negative votes by IPMC members
+<6> Replace _list_ by the names of IPMC members with a negative vote
+
+
+
== Perform the release
If the binding majority approved the vote on both lists continue:
[05/16] incubator-tamaya-site git commit: Continued the rework of the
section 'Tell the others you would proceed with the release procedure'.
Posted by pl...@apache.org.
Continued the rework of the section 'Tell the others you would proceed with the release procedure'.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/commit/46d2b71b
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/tree/46d2b71b
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/diff/46d2b71b
Branch: refs/heads/overhauling-release-guide
Commit: 46d2b71b74eb02b02dfe9a4030535cbf41e048bf
Parents: 7ffeb2d
Author: Oliver B. Fischer <pl...@apache.org>
Authored: Sat Jul 1 12:30:40 2017 +0200
Committer: Oliver B. Fischer <pl...@apache.org>
Committed: Sat Aug 26 11:54:47 2017 +0200
----------------------------------------------------------------------
content/release-guide.adoc | 16 ++++++++++++----
1 file changed, 12 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/46d2b71b/content/release-guide.adoc
----------------------------------------------------------------------
diff --git a/content/release-guide.adoc b/content/release-guide.adoc
index 5d0119c..5b8cc26 100644
--- a/content/release-guide.adoc
+++ b/content/release-guide.adoc
@@ -28,7 +28,7 @@ perform the release procedure.
the release process.
-=== Performing the release
+== Performing the release
=== Tell the others you would proceed with the release procedure
@@ -40,13 +40,19 @@ Take the mail template below, adapt it if necessary, an send it
to mailto:dev@tamaya.incubator.apache.org[dev@tamaya.incubator.apache.org].
-.Announcement of an upcomming release.
+
+.Subject of the announcement of an upcomming release
+----
+Starting with the preparation of the next release of <<project>>
+----
+
+.Body of the announcement of an upcomming release.
[listing,text]
----
Dear all,
If there are no objections, I'll start with the first steps for
-the next release (review, documentation,...).
+the next release of <<project>> (review, documentation,...).
It would be great to start with the release procedure next week.
Best regards,
@@ -54,7 +60,9 @@ Best regards,
----
Don't expect that everyone will response immediately as we all are very
-busy. So be patient with you team members.
+busy. So be patient with you team members. Meanwhile you can
+proceed with the release preparations.
+
---
Rewritten until here
[10/16] incubator-tamaya-site git commit: Corrected the markup and
level of the section 'Prepare the release notes'.
Posted by pl...@apache.org.
Corrected the markup and level of the section 'Prepare the release notes'.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/commit/0c4c3373
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/tree/0c4c3373
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/diff/0c4c3373
Branch: refs/heads/overhauling-release-guide
Commit: 0c4c33738defb05bb2b77c8b2b6f0128b4ab3cfc
Parents: ddc46ca
Author: Oliver B. Fischer <pl...@apache.org>
Authored: Sun Jul 9 00:38:09 2017 +0200
Committer: Oliver B. Fischer <pl...@apache.org>
Committed: Sat Aug 26 11:54:47 2017 +0200
----------------------------------------------------------------------
content/release-guide.adoc | 17 +++++++++--------
1 file changed, 9 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/0c4c3373/content/release-guide.adoc
----------------------------------------------------------------------
diff --git a/content/release-guide.adoc b/content/release-guide.adoc
index b0ba895..5636ac4 100644
--- a/content/release-guide.adoc
+++ b/content/release-guide.adoc
@@ -81,19 +81,20 @@ actual release process.
.. how long it takes to resolve it and if someone can help.
-== Prepare the release notes
+=== Prepare the release notes
* Create release notes and commit them to the `/readme/`
directory of the project. The file name of the release
notes document should be `ReleaseNotes-[version].html`.
-# Question: How to handle the problem that we actually have
-# to distributions? One is API&Core and the second is the
-# extension distribution? At the moment the release notes
-# are part of API&Core. The Extensions contain only a
-# reference to API&Core
-# Oliver B. Fischer, 2017-07-08
-#
+// Question: How to handle the problem that we actually have
+// to distributions? One is API&Core and the second is the
+// extension distribution? At the moment the release notes
+// are part of API&Core. The Extensions contain only a
+// reference to API&Core
+// Oliver B. Fischer, 2017-07-08
+//
+
---
Rewritten until here
[02/16] incubator-tamaya-site git commit: Added missing description
on the vote mail to the developer mailinglist.
Posted by pl...@apache.org.
Added missing description on the vote mail to the developer mailinglist.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/commit/d7b41927
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/tree/d7b41927
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/diff/d7b41927
Branch: refs/heads/overhauling-release-guide
Commit: d7b41927b423835cfc049693f2910d6d1515d87f
Parents: 89b172b
Author: Oliver B. Fischer <pl...@apache.org>
Authored: Sat Aug 12 19:36:14 2017 +0200
Committer: Oliver B. Fischer <pl...@apache.org>
Committed: Sat Aug 26 11:54:47 2017 +0200
----------------------------------------------------------------------
content/release-guide.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/d7b41927/content/release-guide.adoc
----------------------------------------------------------------------
diff --git a/content/release-guide.adoc b/content/release-guide.adoc
index fff6ff2..1d373b6 100644
--- a/content/release-guide.adoc
+++ b/content/release-guide.adoc
@@ -333,7 +333,7 @@ to mailto:dev@tamaya.incubator.apache.org[dev@tamaya.incubator.apache.org].
<2> Replace _version_ by the version number of the release
[listing,text]
-.mm
+.Body of the vote on the release candidate
----
[VOTE] Release of [project] [version] <1> <2>
[09/16] incubator-tamaya-site git commit: Overhauled the section
'Prepare the release notes'.
Posted by pl...@apache.org.
Overhauled the section 'Prepare the release notes'.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/commit/ddc46ca3
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/tree/ddc46ca3
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/diff/ddc46ca3
Branch: refs/heads/overhauling-release-guide
Commit: ddc46ca30bead1955926e3a60f1c91e21b9f8a58
Parents: 3726bcd
Author: Oliver B. Fischer <pl...@apache.org>
Authored: Sat Jul 8 23:58:27 2017 +0200
Committer: Oliver B. Fischer <pl...@apache.org>
Committed: Sat Aug 26 11:54:47 2017 +0200
----------------------------------------------------------------------
content/release-guide.adoc | 18 ++++++++++++++++--
1 file changed, 16 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/ddc46ca3/content/release-guide.adoc
----------------------------------------------------------------------
diff --git a/content/release-guide.adoc b/content/release-guide.adoc
index 9a7eb28..b0ba895 100644
--- a/content/release-guide.adoc
+++ b/content/release-guide.adoc
@@ -80,18 +80,32 @@ actual release process.
.. if the issue can be postponed for the next release
.. how long it takes to resolve it and if someone can help.
+
+== Prepare the release notes
+
+* Create release notes and commit them to the `/readme/`
+ directory of the project. The file name of the release
+ notes document should be `ReleaseNotes-[version].html`.
+
+# Question: How to handle the problem that we actually have
+# to distributions? One is API&Core and the second is the
+# extension distribution? At the moment the release notes
+# are part of API&Core. The Extensions contain only a
+# reference to API&Core
+# Oliver B. Fischer, 2017-07-08
+#
---
Rewritten until here
---
-== Prepare the release
-* Create release notes and commit them to `tamaya/readme/` (format `ReleaseNotes-[version].html`)
+
* Create a release branch in git and switch to this branch:
+
=== Using the Release Plugin
For performing the release you can use the maven release plugin:
[14/16] incubator-tamaya-site git commit: Change parts in the
sections: - Preparing the vote of the PPMC on the release - Preparing the
release without the Release Plugin
Posted by pl...@apache.org.
Change parts in the sections:
- Preparing the vote of the PPMC on the release
- Preparing the release without the Release Plugin
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/commit/71ccb113
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/tree/71ccb113
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/diff/71ccb113
Branch: refs/heads/overhauling-release-guide
Commit: 71ccb113c1c884198baeac63f59398f68a89b585
Parents: da3e57b
Author: Oliver B. Fischer <pl...@apache.org>
Authored: Thu Aug 10 20:57:50 2017 +0200
Committer: Oliver B. Fischer <pl...@apache.org>
Committed: Sat Aug 26 11:54:47 2017 +0200
----------------------------------------------------------------------
content/release-guide.adoc | 149 +++++++++++++++++++++++++++++++---------
1 file changed, 117 insertions(+), 32 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/71ccb113/content/release-guide.adoc
----------------------------------------------------------------------
diff --git a/content/release-guide.adoc b/content/release-guide.adoc
index 69ac10a..86b8dfa 100644
--- a/content/release-guide.adoc
+++ b/content/release-guide.adoc
@@ -3,8 +3,6 @@
:sectnums: yes
-# to read before
-# https://incubator.apache.org/guides/releasemanagement.html
// to read before
// https://incubator.apache.org/guides/releasemanagement.html
// http://www.apache.org/legal/release-policy.html
@@ -121,7 +119,7 @@ as the PPMC of Apache Tamaya have approved the release.
====
Before you can present the proposed release to the
-IPMC of the Apache Incubator, the proposd release must be
+IPMC of the Apache Incubator, the proposed release must be
approved by the PPMC of the Tamaya project.
Therefore you must run a vote on the proposed release
@@ -133,6 +131,13 @@ repository in Apache's Nexus. This sounds complicated
but it isn't that complicated if you follow the steps
of this guide.
+In case the vote candidate does not pass the vote of
+the PPMC or the IPMC you can choose between
+canceling the current attempt for the next release
+or you try to fix the issues which hinders people to
+vote with yes. If you have choosen the second
+way then you have to prepare a new vote candidat.
+
---
Rewritten until here
---
@@ -147,74 +152,154 @@ Rewritten until here
=== Preparing the release without the Release Plugin
-The release plugin is great, but in some cases it breaks even, when release:prepare -DdryRun=true was successful.
-Preparing the release vote without the release plugin is stright forward:
+[NOTE]
+====
+We tried to use the http://maven.apache.org/maven-release/maven-release-plugin/[Maven Release Plugin^]
+to increase the level of automatisation of the release process, but
+we were not able to get the Maven Release Plugin working as we
+need it for our release process. Therefore we decided not to use
+it.
+====
-* As described checkout a release branch of the current head
-* Then us maven and git commands to prepare the release:
+The first step is to create a separate branch for the release canidate.
+The name should consist of the release version and the number of the
+voting candidate.
-[listing,text]
+For example if you would like to run a vote for the 1.0 release of
+Tamaya API&Core during its incubation for the second time, the usual
+branch name would be `vote-1.0-incubating-02`.
+
+Follow the instructions below to create the branch for the vote
+and to build the vote candidate.
+
+[code,text]
+.Creating the vote branch and building the vote candidat
----
-$ git checkout -b vote-tamaya-[release version]
+$ git checkout -b vote-[release version]-[attempt] <1> <2>
$ export MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=200m"
$ mvn versions:set versions:commit -DnewVersion=[release version] -DperformRelease=true
-# build the release locally and sign it with your certs
-$ mvn clean install -DperformRelease=true -Dgpg.keyname=1336D3E6 -Dgpg.passphrase=XXXXXX
+$ mvn clean install -DperformRelease=true -Dgpg.keyname=[key] -Dgpg.passphrase=[passphrase] <3> <4>
+
----
+<1> The version number of the planed release, e.g. `0.4-incubating`
+<2> The number of the current vote, e.g. `03`
+<3> The id of your GPG key.
+<4> The passphrase of you GPG key.
-* Check if everything is in place and correct, when finished you can tag and deploy the release...
+Now you can check the source distribution and the Maven artifacts created
+during the build.
+
+If everything is correct, deploy them to a staging repository on Apache's
+Nexus.
[listing,text]
+.Deploying the vote candidate to Apache's Nexus'
----
-$ mvn deploy -DperformRelease=true -Dgpg.keyname=1336D3E6 -Dgpg.passphrase=XXXXXX
+$ mvn deploy
----
-* check the created commits including user-name and email
-* login to https://repository.apache.org/[^] and go to "Staging Repositories"
-* check the contents of the newly created tamaya staging repository
-* _close_ the repository to let Nexus do its validations
-* On success:
-* push the release-branch to the git repo
+// Check if these commandline parameters are needed
+// -DperformRelease=true -Dgpg.keyname=[key] -Dgpg.passphrase=[passphrase] <1> <2>
+
+After deploying the artifacts you have to check the staging repository
+created in Apache's Nexus:
+
+1. Login to https://repository.apache.org/[^] and go to _Staging Repositories_.
+2. Check the Contents of the newly create staging repository for you release.
+3. Close the staging repository to let Nexus do its validations on the deployed
+ artifacts.
+
+IMPORTANT: Do not release the content of the stating repository right now.
+ Releasing means to publish the artifacts. This will be done
+ after a successful vote of the IPMC.
+
+
+If everything is correct until now, commit your local changes, create a tag for
+the voting candidate and push the tag and your commits to the Git
+repository.
+
[listing,text]
+.Commiting the changes done for the vote candidate
----
$ git add -A
$ git commit -m "Release Prepare: Set release version."
-$ git tag vote01-[release-version]
+$ git tag vote-[release version]-[attempt]
$ git push --tags
----
-Finally open the next development version:
+<1> The version number of the planed release, e.g. `0.4-incubating`
+<2> The number of the current vote, e.g. `03`
+
+Finally open the next development version of the project.
[listing,text]
+.Set next development version of the project
----
-# example: newVersion=0.3-incubating-SNAPSHOT
-$ mvn version:set versions:commit -DnewVersion=[development-version]
+$ mvn version:set versions:commit -DnewVersion=[development version] <1>
$ git add -A
$ git commit -m "Release Prepare: Open new development version."
----
+<1> Next development version, e.g. `0.83-incubating-SNAPSHOT`
+After setting the new development version you have to add the source
+distribution to the distribution repository at https://dist.apache.org/repos/dist/[^].
+IMPORTANT: The source distribution and all required artifacts must be added
+ to the development directory of Apache's distribution server.
+ After the approvement of the release candidate by the PPMC and
+ the IPMC they will be moved to the release directory.
-* Add the distribution artifacts to the dev repositories:
[listing,text]
+.Adding all needed artifacts to distribution repository
----
$ svn co https://dist.apache.org/repos/dist/dev/incubator/tamaya/
-$ mkdir [version]
-$ set RELEASE_HOME='pwd'/[version]
-$ cd PROJECT_ROOT
+$ mkdir [release version]/[project] <1>
+$ set RELEASE_HOME=`pwd`/[release version]/[project]
+$ set PROJECT_ROOT=[repository of the project] <2>
+$ cd $PROJECT_ROOT
$ cp DISCLAIMER $RELEASE_HOME
$ cp NOTICE $RELEASE_HOME
$ cp LICENCE $RELEASE_HOME
-$ cp rat.txt $RELEASE_HOME
-# Copy everything from
-# $STAGING_REPO/distribution/0.2-incubating/tamaya-distribution-[version]-distribution-* into $RELEASE_HOME
+$ cp keys/KEYS $RELEASE_HOME
+$ cp $PROJECT_ROOT/cp distribution/target/*{.tar.gz,.zip,.asc} $RELEASE_HOME <3>
+$ svn add [version]
+$ svn add [version]/[project]
+----
+<1> We store the artifacts of Tamaya API&Core and Tamaya Extensions always
+ in different subdirectories. So _project_ can be either
+ `apiandcore` or `extensions`.
+<2> `PROJECT_ROOT` is the Git repository of the project which you want to
+ release.
+<3> This command copies both distribution archives to `$RELEASE_HOME`.
+
+Additionally there must be a SHA-1 and MD5 sigature file for each distribution
+archive and its GPG signature (`.asc`). To generate them you need programs
+like `md5` and `shasum`. The name of these programs might vary from system to system.
+
+
+[listing,text]
+.Generating the required SHA-1 and MD5 signatures
+----
+$ cd $RELEASE_HOME
+$ for f in $(ls *{.tar.gz,.zip,.asc}); do shasum -a 1 $f > ${f}.sha1; md5 $f > ${f}.md5; done
+----
+
+After generating the signature files you can add and commit all files and artifacts
+of the source distribution.
+
+[listing,text]
+.Adding and commiting the source distribution
+----
+$ cd $RELEASE_HOME
+$ svn add [project]
$ svn add [version]
-$ svn commit --username <apacheId>
+$ svn commit --username [Apache ID]
----
-* Check contents on https://dist.apache.org/repos/dist/dev/incubator/tamaya/[version]
+All commited files and artifacts should be now available via
+https://dist.apache.org/repos/dist/dev/incubator/tamaya/[https://dist.apache.org/repos/dist/dev/incubator/tamaya/[version]/[project]^].
== Start the vote
[03/16] incubator-tamaya-site git commit: Started to incorporate the
differences in the release procedure between Tamaya API&Core and Tamaya
Extensions.
Posted by pl...@apache.org.
Started to incorporate the differences in the release procedure between Tamaya API&Core and Tamaya Extensions.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/commit/85e051a5
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/tree/85e051a5
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/diff/85e051a5
Branch: refs/heads/overhauling-release-guide
Commit: 85e051a5a36d30672152979b773cfd9ced8b3a95
Parents: 1c2d7c1
Author: Oliver B. Fischer <pl...@apache.org>
Authored: Sun Aug 6 11:13:57 2017 +0200
Committer: Oliver B. Fischer <pl...@apache.org>
Committed: Sat Aug 26 11:54:47 2017 +0200
----------------------------------------------------------------------
content/release-guide.adoc | 29 +++++++++++++++--------------
1 file changed, 15 insertions(+), 14 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/85e051a5/content/release-guide.adoc
----------------------------------------------------------------------
diff --git a/content/release-guide.adoc b/content/release-guide.adoc
index d9c33c6..8c7e8a6 100644
--- a/content/release-guide.adoc
+++ b/content/release-guide.adoc
@@ -3,17 +3,19 @@
:sectnums: yes
+# to read before
+# https://incubator.apache.org/guides/releasemanagement.html
+
= Apache Tamaya Release Guide
-This document describes how to perform a release of Apache Tamaya during
+[abstract]
+This document describes how to perform a release of Apache Tamaya
+API&Core and Apache Tamaya Extensions during
its incubation. It contains a step by step description of each step,
so everybody in the commiters's team will be able to perform
the release procedure during the incubation phase.
-
-
-#Performing a release requires several steps. This document describes each
-#step, so everybody in the committer's
-#team should be able to perform the release procedure.
+Differences in the procedure between Tamaya API&Core and Tamaya
+Extensions are mentioned.
== Prerequisites
@@ -87,14 +89,13 @@ actual release process.
directory of the project. The file name of the release
notes document should be `ReleaseNotes-[version].html`.
-// Question: How to handle the problem that we actually have
-// to distributions? One is API&Core and the second is the
-// extension distribution? At the moment the release notes
-// are part of API&Core. The Extensions contain only a
-// reference to API&Core
-// Oliver B. Fischer, 2017-07-08
-//
-
+[TIP]
+====
+Ensure that you include only notes an the release notes
+which affect the project you are releasing.
+For instance a notes on an issues which affects Tamaya Extensions
+should not be included in the release notes of Tamaya API&Core.
+====
=== Preparing the vote of the PPMC on the release
[06/16] incubator-tamaya-site git commit: Removed the section 'Using
the Release Plugin' from the release guide as we always had problems with the
release plugin.
Posted by pl...@apache.org.
Removed the section 'Using the Release Plugin' from the release guide as we always had problems with the release plugin.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/commit/1c2d7c13
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/tree/1c2d7c13
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/diff/1c2d7c13
Branch: refs/heads/overhauling-release-guide
Commit: 1c2d7c13010898b0b46317762331adcb19b30175
Parents: 0a75595
Author: Oliver B. Fischer <pl...@apache.org>
Authored: Sun Jul 9 01:00:28 2017 +0200
Committer: Oliver B. Fischer <pl...@apache.org>
Committed: Sat Aug 26 11:54:47 2017 +0200
----------------------------------------------------------------------
content/release-guide.adoc | 25 -------------------------
1 file changed, 25 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/1c2d7c13/content/release-guide.adoc
----------------------------------------------------------------------
diff --git a/content/release-guide.adoc b/content/release-guide.adoc
index 9dfbeae..d9c33c6 100644
--- a/content/release-guide.adoc
+++ b/content/release-guide.adoc
@@ -141,31 +141,6 @@ Rewritten until here
-=== Using the Release Plugin
-
-For performing the release you can use the maven release plugin:
-
-[listing,text]
-----
-$ git checkout -b vote-tamaya-[release version]
-$ export MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=200m"
-$ mvn release:prepare -DdryRun=true -DperformRelease=true
-# optionally pass GPG params for signing with: -Darguments="-Dgpg.keyname=1336D3E6 -Dgpg.passphrase=XXXXXX"
-# copy prepared workspace (to continue faster if an upload fails in the next step)
-----
-
-* If something fails you may switch to the master branch, fix whatever is needed and rebase your release branch to
- accommodate the latest changes done.
-* On success you can check the release packages from `dist/target`.
-* If everything looks good you can proceed with the release:
-
-[listing,text]
-----
-$ export MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=200m"
-$ mvn release:prepare -DperformRelease=true
-$ mvn release:perform -DperformRelease=true
-----
-
=== Preparing the release without the Release Plugin
The release plugin is great, but in some cases it breaks even, when release:prepare -DdryRun=true was successful.
[08/16] incubator-tamaya-site git commit: Added a word in the section
'Check everything is ready'.
Posted by pl...@apache.org.
Added a word in the section 'Check everything is ready'.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/commit/3726bcd4
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/tree/3726bcd4
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/diff/3726bcd4
Branch: refs/heads/overhauling-release-guide
Commit: 3726bcd4a72bf989c71da96f4338edfaeb308cae
Parents: d31fc25
Author: Oliver B. Fischer <pl...@apache.org>
Authored: Sat Jul 1 12:43:09 2017 +0200
Committer: Oliver B. Fischer <pl...@apache.org>
Committed: Sat Aug 26 11:54:47 2017 +0200
----------------------------------------------------------------------
content/release-guide.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/3726bcd4/content/release-guide.adoc
----------------------------------------------------------------------
diff --git a/content/release-guide.adoc b/content/release-guide.adoc
index 332c1de..9a7eb28 100644
--- a/content/release-guide.adoc
+++ b/content/release-guide.adoc
@@ -68,7 +68,7 @@ proceed with the release preparations.
The following items must be done before you can start with the
actual release process.
-. Check if the build chains
+. Check if the build chains in
https://builds.apache.org/view/Tamaya/[Apache's Jenkins^]
of the project in to be released are fine and where are
no problems with the build and quality of the project.
[15/16] incubator-tamaya-site git commit: Overhauled the section
'Perform the release' and replaced the sections on updating the website and
on the announcement by a new section called 'Updating the website and
announcing the release'.
Posted by pl...@apache.org.
Overhauled the section 'Perform the release' and replaced the sections on updating the website and on the announcement by a new section called 'Updating the website and announcing the release'.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/commit/3acfb601
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/tree/3acfb601
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/diff/3acfb601
Branch: refs/heads/overhauling-release-guide
Commit: 3acfb6016c945338a2fadd7d7275b445f158bc39
Parents: cb92dd6
Author: Oliver B. Fischer <pl...@apache.org>
Authored: Sun Aug 13 12:51:20 2017 +0200
Committer: Oliver B. Fischer <pl...@apache.org>
Committed: Sat Aug 26 11:54:47 2017 +0200
----------------------------------------------------------------------
content/release-guide.adoc | 123 ++++++++++++++++++++++++++++++++--------
1 file changed, 98 insertions(+), 25 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/3acfb601/content/release-guide.adoc
----------------------------------------------------------------------
diff --git a/content/release-guide.adoc b/content/release-guide.adoc
index 542b23c..28d2d54 100644
--- a/content/release-guide.adoc
+++ b/content/release-guide.adoc
@@ -536,61 +536,134 @@ Z -1 votes: <5>
-== Perform the release
+== Performing the release
-If the binding majority approved the vote on both lists continue:
+The actually release process can be started if the binding majority
+of IPMC members have approved the release candidate.
-* Login to https://repository.apache.org/ and _release_ the repository
-* Rename the vote branch:
+The first task is to create branch for the new release
+out of the branch, created for the vote on the release candidate.
-[listing,text]
+=== Tag and branch for the release
+
+Creating this branch requires multiple commands, as Git does not
+allow to simply rename a remote branch. The listing below shows
+which commands are needed to create a branch for the new release
+
+[listing,shell]
+.Renaming the branch of the release candidate
----
-$ git branch -m vote01-tamaya-[release-version] tamaya-[release-version]
+$ git checkout master <1>
+$ git branch release-[version] vote-[version]-[attempt] <2> <3> <4>
+$ git push origin release-[version]:refs/heads/release-[version] <5>
+$ git push origin :vote-[version]-[attempt] <6>
+$ git branch -D vote-[version]-[attempt] <7>
+$ git checkout -b release-[version] --track origin/release-[version] <8>
----
+<1> Switching back to `master`
+<2> Creating a release branch out of the vote branch
+<3> Replace _version_ by the version number of the release
+<4> Replace _attempt_ by the number of the successful vote attempt
+<5> Pushing the new branch under the same name to the blessed repository
+<6> Delete the vote branch in the blessed remote repository
+<7> Delete the branch locally
+<8> Checkout the new release branch and set the corresponding
+ remote branch as upstream branch
+
-* Add a release tag:
+Now create a new tag for the release based on the exsting tag
+for the release candidate and delete the tag made for
+the release candidate:
+[listing,shell]
----
-$ git tag -a tamaya-[release-version]
+$ git tag release-[version] vote-[version]-[attempt] <1> <2> <3>
+$ git tag -d vote-[version]-[attempt] <4>
+$ git push origin :vote-[version]-[attempt] <5>
+$ git push --tags origin <6>
----
+<1> Creating a release tag for the release
+<2> Replace _version_ by the version number of the release
+<3> Replace _attempt_ by the number of the successful vote attempt
+<4> Delete the tag made for the vote locally
+<5> Delete tag tag mode for the vote in the blessed remote repository
+<6> Push the new tag to the remote repository
-* Merge master with the new prepared version:
+Now you can merge the new release branch with the prepared
+development version to master.
[listing,text]
+.Merging the release branch to `master`
----
$ git checkout master
-$ git merge tamaya-[release-version]
-$ git push origin tamaya-[release-version]
+$ git merge release-[version]
$ git push origin master
----
-* Close the release and corresponding tickets at JIRA
+=== Cleanup Jira
+
+Login into https://issues.apache.org/jira/browse/tamaya[Apache's Jira] and
+close all issues in the
+https://issues.apache.org/jira/browse/tamaya[Tamaya project^].
+
+=== Release the staging repository
+
+Login into https://repository.apache.org/[Apaches Nexus^] and
+release to staging repository for the new release.
-* Wait some minutes and check http://repo2.maven.org/maven2/org/apache/tamaya[^]
+Then wait some minutes and check if the artifacts have become
+available at http://repo2.maven.org/maven2/org/apache/tamaya[^].
-* Upload the distribution Artifacts
+=== Releasing the distribution artifacts
+
+The source distribution of the release candidate must now be
+moved from the dev section of the distribution repository
+to the release section.
+
+An easy way to achive this is to use the `svn mv` command
+only with remote URLs. Before you move the distribution artifacts,
+make sure the the directory for the version of the projects exists.
[listing,text]
+.Checking if the target directory exists in SVN
----
-$ svn co https://dist.apache.org/repos/dist/release/incubator/tamaya/
-$ mkdir [version]
-# add and commit the artifacts (*source-release.zip, *bin-release.zip + asc, md5, sha1)
-# use the artifacts from:
-# http://repo1.maven.org/maven2/org/apache/tamaya/tamaya-distribution/[version]/
+$ svn ls https://dist.apache.org/repos/dist/release/incubator/tamaya
----
+If the directory does not exists, create it.
-== Updating the Tamaya Project Site
+[listing,text]
+.Creating the directory for the version of the release
+----
+$ svn mkdir https://dist.apache.org/repos/dist/release/incubator/tamaya/[versio] <1>
+----
+<1> Replace _version_ by the version number of the release.
-Basically the new site should be directly deployable, just execute
+Now move all distribution artifacts from the dev section to the release
+section.
[listing,text]
+.Moving the source distribution to the release section with SVN
+----
+$ svn mv \
+ https://dist.apache.org/repos/dist/dev/incubator/tamaya/[version]/[project] \ <1> <2>
+ https://dist.apache.org/repos/dist/release/incubator/tamaya/[version]/[project]
+----
+<1> Replace _version_ by the version number of the release.
+<2> Replace _project_ by the name of the project.
+
+To be sure that everything wents well, perform a checkout of the SVN
+repository for the release section and check if everything is there.
+
+[listing,shell]
----
-$ mvn site site:deploy
+$ svn checkout https://dist.apache.org/repos/dist/release/incubator/tamaya
+$ cd tamaya
+$ ls -Rlah
----
-== Announce the new version
+== Updating the website and announcing the release
-Announce the new version on @TamayaConf and other social media channels.
-Also drop a short mail on the mailing list.
+Coordindate on the developers mailinglist the update of the website
+for the new version and the announcement of the new version.
[11/16] incubator-tamaya-site git commit: Added a new section called
'Preparing the vote of the PPMC on the release'.
Posted by pl...@apache.org.
Added a new section called 'Preparing the vote of the PPMC on the release'.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/commit/0a755959
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/tree/0a755959
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/diff/0a755959
Branch: refs/heads/overhauling-release-guide
Commit: 0a755959e587b5729b2aad0861610154e0b53f1a
Parents: 0c4c337
Author: Oliver B. Fischer <pl...@apache.org>
Authored: Sun Jul 9 00:56:55 2017 +0200
Committer: Oliver B. Fischer <pl...@apache.org>
Committed: Sat Aug 26 11:54:47 2017 +0200
----------------------------------------------------------------------
content/release-guide.adoc | 38 ++++++++++++++++++++++++++++++++++++--
1 file changed, 36 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/0a755959/content/release-guide.adoc
----------------------------------------------------------------------
diff --git a/content/release-guide.adoc b/content/release-guide.adoc
index 5636ac4..9dfbeae 100644
--- a/content/release-guide.adoc
+++ b/content/release-guide.adoc
@@ -95,12 +95,46 @@ actual release process.
// Oliver B. Fischer, 2017-07-08
//
----
-Rewritten until here
+=== Preparing the vote of the PPMC on the release
+
+If you are sure that everything is ready for the
+next release you can start the vote of the PPMC
+on the proposed release.
+
+[IMPORTANT]
+====
+Keep in mind that preparing the release
+really means only to prepare the release by
+uploading it to the dev area of the
+https://dist.apache.org[distribution
+server of the Apache project^] and to a staging
+repository of https://repository.apache.org[Apache's Nexus^].
+
+You must not publish the artifacts created during
+the preparation of the release until the IPMC as well
+as the PPMC of Apache Tamaya have approved the release.
+====
+
+Before you can present the proposed release to the
+IPMC of the Apache Incubator, the proposd release must be
+approved by the PPMC of the Tamaya project.
+
+Therefore you must run a vote on the proposed release
+by creating a vote candidat in the Git repository of
+the project, uploading the source distribution
+to the dev area of the distribution server of the Apache
+project and uploading the Maven artifacts to a staging
+repository in Apache's Nexus. This sounds complicated
+but it isn't that complicated if you follow the steps
+of this guide.
---
+Rewritten until here
+---
+
+//==== Creating a vote candidat in the Git repository
* Create a release branch in git and switch to this branch:
[13/16] incubator-tamaya-site git commit: Overhauled the section on
the project internal voting process on a release candidate.
Posted by pl...@apache.org.
Overhauled the section on the project internal voting process on a release candidate.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/commit/89b172b0
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/tree/89b172b0
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/diff/89b172b0
Branch: refs/heads/overhauling-release-guide
Commit: 89b172b0617e6f95ec4890f6dd1abb388f66dfd1
Parents: 71ccb11
Author: Oliver B. Fischer <pl...@apache.org>
Authored: Sat Aug 12 16:13:07 2017 +0200
Committer: Oliver B. Fischer <pl...@apache.org>
Committed: Sat Aug 26 11:54:47 2017 +0200
----------------------------------------------------------------------
content/release-guide.adoc | 115 +++++++++++++++++++++++++++++-----------
1 file changed, 85 insertions(+), 30 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/89b172b0/content/release-guide.adoc
----------------------------------------------------------------------
diff --git a/content/release-guide.adoc b/content/release-guide.adoc
index 86b8dfa..fff6ff2 100644
--- a/content/release-guide.adoc
+++ b/content/release-guide.adoc
@@ -302,65 +302,120 @@ All commited files and artifacts should be now available via
https://dist.apache.org/repos/dist/dev/incubator/tamaya/[https://dist.apache.org/repos/dist/dev/incubator/tamaya/[version]/[project]^].
-== Start the vote
+== Run the vote on the release candidate
+
+=== Run the internally
+
+The next step is to prepare the vote on mailto:dev@tamaya.incubator.apache.org[^].
+The mail must contain serveral links, e.g. a link to the source distribution
+and a link to the tag in the Git repository.
+
+The following links are needed for the mail:
+
+1. A link to the source distribution in the dev section of the distribution repository
+ at https://dist.apache.org/repos/dist/dev/incubator/tamaya/[^].
+2. A link to the tag of the release candidate, taken from
+ https://git1-us-west.apache.org/repos/asf?p=incubator-tamaya.git;a=summary[^].
+3. A link to the staging repository for the release candidate of the intended
+ relase at http://repository.apache.org/content/repositories[^].
+4. A link to to the http://www.apache.org/foundation/voting.html#ReleaseVotes[rules for release votes^]
+ in the _Apache Voting Process_ document.
+
+Take the mail template below, insert the links, an send it
+to mailto:dev@tamaya.incubator.apache.org[dev@tamaya.incubator.apache.org].
[listing,text]
+.Subject of the vote on the release candidate
+----
+[Vote] Release of [project] [version] <1> <2>
----
-[VOTE] Release of Apache Tamaya [version]
+<1> Replace _project_ by either Apache Tamaya API&Core or Apache Tamaya Extensions
+<2> Replace _version_ by the version number of the release
-Hi,
+[listing,text]
+.mm
+----
+[VOTE] Release of [project] [version] <1> <2>
-I was running the needed tasks to get the [version] release of Apache Tamaya out.
-The artifacts are deployed to Nexus [1] (and [2]) and releases [4].
+Hi,
-The tag is available at [3] and will renamed once the vote passed.
+I was running the needed tasks to get the [version] release of [project] out. <1> <2>
+The artifacts available via the Apache distribution repository [1] and
+also via Apache's Nexus [2].
+The tag for this release candidate is available at [3] and will be renamed
+once the vote passed.
Please take a look at the artifacts and vote!
Please note:
-This vote is a "majority approval" with a minimum of three +1 votes (see [5]).
+This vote is a "majority approval" with a minimum of three +1 votes (see [4]).
------------------------------------------------
[ ] +1 for community members who have reviewed the bits
[ ] +0
-[ ] -1 for fatal flaws that should cause these bits not to be released, and why..............
+[ ] -1 for fatal flaws that should cause these bits not to be released, and why ...
------------------------------------------------
Thanks,
[name]
-[1] https://repository.apache.org/content/repositories/...
-[2] https://repository.apache.org/content/repositories/org/apache/tamaya/tamaya-distribution/[version]/tamaya-[version]-source-release.zip
- https://repository.apache.org/content/repositories/org/apache/tamaya/tamaya-distribution/[version]/tamaya-[version]-bin-release.zip
-[3] https://git1-us-west.apache.org/repos/asf?p=incubator-tamaya.git;a=commit;h=2910da468fce16210e6dd77d8ba23ddbdd434efe
-[4] https://dist.apache.org/repos/dist/dev/incubator/tamaya/[release-version]
-[5] http://www.apache.org/foundation/voting.html#ReleaseVotes
-----
-
-* Announce the Vote
- ** Create a short link to the release at http://s.apache.org (format Tamaya_[version])
- ** Tweet about the vote via _@TamayaConf_
-
-* After 72 hours close the vote write a reult email, e.g.
+[1] [link to the source distribution] <3>
+[2] [link to the staging repository at Apache's Nexus] <4>
+[3] [link to the tag in the Git repository] <5>
+[4] http://www.apache.org/foundation/voting.html#ReleaseVotes
+----
+<1> Replace _project_ by the name of the project to be release, which can be
+ _Apache Tamaya API&Core_ or _Apache Tamaya Extensions_.
+<2> Replease _version_ by the version number of the intended release.
+<3> Insert here the link to the source distribution of the project
+ in the dev section of distribution repository
+ at https://dist.apache.org/repos/dist/dev/incubator/tamaya/[^].
+<4> Insert here the link to the staging repository for the release candidate
+ at http://repository.apache.org/content/repositories[^].
+<5> Insert here the link to the tag created for the release candidate
+ in the Git repository.
+
+Wait at least 72 hours before you close the result. If there is not enough attention
+at the mailing list to vote, send a nice reminder to the list. Please keep in mind
+that people might be simple to busy to respond on your vote.
+
+To close the vote count all single votes and send the result as reply to your
+initial mail to the mailinglist by using the templates below.
[listing,text]
+.Subject of the mail with the result of the vote
----
-[Result] (was: Re: [VOTE] Release of Apache Tamaya [version])
+[Result] (was: Re: [VOTE] Release of [project] [version]) <1> <2>
+----
+<1> Replace _project_ by the name of the project to be release, which can be
+ _Apache Tamaya API&Core_ or _Apache Tamaya Extensions_.
+<2> Replease _version_ by the version number of the intended release.
+[listing,text]
+.Body of the mail with the result of the vote
+----
Thank you for voting!
-X binding +1 votes (pmc):
-[list]
+X binding +1 votes (PPMC): <1>
+[list] <2>
-Y non-binding +1 votes:
-[list]
+Y non-binding +1 votes: <3>
+[list] <4>
-Z -1 votes
-[list]
+Z -1 votes: <5>
+[list] <6>
----
+<1> Replace _X_ by the number of positive votes by PPMC members
+<2> Replace _list_ by the names of PPMC members with a positive vote
+<3> Replace _Y_ by the number of non-binding positive votes by
+ non-PPMC members
+<4> Replace _list_ by the names of non-PPMC members with a positive vote
+<5> Replace _Z_ by the number of negative votes by PPMC members
+<6> Replace _list_ by the names of PPMC members with a negative vote
+
-* After the vote on the PPMC has been finished and is successful, repeat the voting process on the
- incubator mailing list.
+After the vote on the PPMC has been finished and is successful,
+repeat the voting process on the incubator mailing list.
== Perform the release
[12/16] incubator-tamaya-site git commit: Changed the format of the
first sentence from 'abstract' to '.lead'.
Posted by pl...@apache.org.
Changed the format of the first sentence from 'abstract' to '.lead'.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/commit/da3e57be
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/tree/da3e57be
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/diff/da3e57be
Branch: refs/heads/overhauling-release-guide
Commit: da3e57be4b005361d99f6cca0e41d7bf1468c457
Parents: 85e051a
Author: Oliver B. Fischer <pl...@apache.org>
Authored: Thu Aug 10 20:54:24 2017 +0200
Committer: Oliver B. Fischer <pl...@apache.org>
Committed: Sat Aug 26 11:54:47 2017 +0200
----------------------------------------------------------------------
content/release-guide.adoc | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/da3e57be/content/release-guide.adoc
----------------------------------------------------------------------
diff --git a/content/release-guide.adoc b/content/release-guide.adoc
index 8c7e8a6..69ac10a 100644
--- a/content/release-guide.adoc
+++ b/content/release-guide.adoc
@@ -5,10 +5,13 @@
# to read before
# https://incubator.apache.org/guides/releasemanagement.html
+// to read before
+// https://incubator.apache.org/guides/releasemanagement.html
+// http://www.apache.org/legal/release-policy.html
= Apache Tamaya Release Guide
-[abstract]
+[.lead]
This document describes how to perform a release of Apache Tamaya
API&Core and Apache Tamaya Extensions during
its incubation. It contains a step by step description of each step,
[04/16] incubator-tamaya-site git commit: Startet with the rework of
the release guide. Added a section on the prerequisites to be able to perform
the release process and overhauled the section 'Tell the others you would
proceed with the release procedur
Posted by pl...@apache.org.
Startet with the rework of the release guide. Added a section on the prerequisites to be able to perform the release process and overhauled the section 'Tell the others you would proceed with the release procedure'.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/commit/7ffeb2db
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/tree/7ffeb2db
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/diff/7ffeb2db
Branch: refs/heads/overhauling-release-guide
Commit: 7ffeb2db2d4b04d3f11219bd91eb22efe74a62ff
Parents: 1391ae8
Author: Oliver B. Fischer <pl...@apache.org>
Authored: Tue Jun 27 23:36:48 2017 +0200
Committer: Oliver B. Fischer <pl...@apache.org>
Committed: Sat Aug 26 11:54:47 2017 +0200
----------------------------------------------------------------------
content/release-guide.adoc | 51 ++++++++++++++++++++++++++++++++++-------
1 file changed, 43 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/7ffeb2db/content/release-guide.adoc
----------------------------------------------------------------------
diff --git a/content/release-guide.adoc b/content/release-guide.adoc
index 332b758..5d0119c 100644
--- a/content/release-guide.adoc
+++ b/content/release-guide.adoc
@@ -3,28 +3,63 @@
:sectnums: yes
-= Apache Tamaya: Release Guide
+= Apache Tamaya Release Guide
-Performing a release requires several steps. This document describes each step, so everybody in the committer's
-team should be able to perform the release procedure.
+This document describes how to perform a release of Apache Tamaya during
+its incubation. It contains a step by step description of each step,
+so everybody in the commiters's team will be able to perform
+the release procedure during the incubation phase.
-== Tell the others you would proceed with the release procedure
+#Performing a release requires several steps. This document describes each
+#step, so everybody in the committer's
+#team should be able to perform the release procedure.
+== Prerequisites
+
+This section describes the prerequisite which must be given to
+perform the release procedure.
+
+["upperroman"]
+
+. Subversion client, needed to upload the source distribution.
+. Git
+. A valid GPG key, needed to sign all artifacts created during
+ the release process.
+
+
+=== Performing the release
+
+=== Tell the others you would proceed with the release procedure
+
+The first step is to announce on developer mailing list that
+you plan to release a new version of Tamaya API&Core as well
+as of the Tamaya Extensions.
+
+Take the mail template below, adapt it if necessary, an send it
+to mailto:dev@tamaya.incubator.apache.org[dev@tamaya.incubator.apache.org].
+
+
+.Announcement of an upcomming release.
[listing,text]
----
-first steps for the next release
-
-Hi @ all,
+Dear all,
If there are no objections, I'll start with the first steps for
the next release (review, documentation,...).
It would be great to start with the release procedure next week.
Best regards,
-[name]
+<<your name>>
----
+Don't expect that everyone will response immediately as we all are very
+busy. So be patient with you team members.
+
+---
+Rewritten until here
+---
+
== Check everything is ready
* Check the jenkins builds.