You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tamaya.apache.org by an...@apache.org on 2016/03/15 15:54:50 UTC
incubator-tamaya git commit: Added release guide.
Repository: incubator-tamaya
Updated Branches:
refs/heads/master 5a5d637cb -> 285ec8d75
Added release guide.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/commit/285ec8d7
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/tree/285ec8d7
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/diff/285ec8d7
Branch: refs/heads/master
Commit: 285ec8d7548241e12a97c6c6c5ac8a93277e9a6e
Parents: 5a5d637
Author: anatole <an...@apache.org>
Authored: Tue Mar 15 15:41:31 2016 +0100
Committer: anatole <an...@apache.org>
Committed: Tue Mar 15 15:41:31 2016 +0100
----------------------------------------------------------------------
.../asciidoc/releaseguide/ReleaseGuide.adoc | 230 +++++++++++++++++++
docs/src/main/asciidoc/releaseguide/readme.md | 3 -
2 files changed, 230 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/285ec8d7/docs/src/main/asciidoc/releaseguide/ReleaseGuide.adoc
----------------------------------------------------------------------
diff --git a/docs/src/main/asciidoc/releaseguide/ReleaseGuide.adoc b/docs/src/main/asciidoc/releaseguide/ReleaseGuide.adoc
new file mode 100644
index 0000000..c7df7ca
--- /dev/null
+++ b/docs/src/main/asciidoc/releaseguide/ReleaseGuide.adoc
@@ -0,0 +1,230 @@
+# Release Guide of Apache Tamaya (incubating)
+
+This directory contains the release guide of Apache Tamaya (incubating).
+=======
+Apache Tamaya -- Release Guide
+==============================
+:name: Tamaya
+:title: Apache Tamaya Release Guide
+:revnumber: 0.1-SNAPSHOT
+:revremark: Incubator
+:revdate: March 2016
+:longversion: {revnumber} ({revremark}) {revdate}
+:authorinitials: ATR
+:author: Anatole Tresch
+:email: <an...@apache.org>
+:source-highlighter: coderay
+:website: http://tamaya.incubator.apache.org/
+:toc:
+:toc-placement: manual
+:encoding: UTF-8
+:numbered:
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+'''
+
+<<<
+
+image::http://tamaya.incubator.apache.org/resources/images/logos/logo_wood.png[]
+
+toc::[]
+
+<<<
+:numbered!:
+-----------------------------------------------------------
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-----------------------------------------------------------
+
+:numbered:
+
+
+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.
+
+
+== Tell the others you would proceed with the release procedure
+
+[listing,text]
+----------------------------------------
+ first steps for the next release
+
+ hi @ 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.
+
+ regards,
+ [name]
+----------------------------------------
+
+
+== 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.
+
+
+== 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:
+
+[listing,text]
+----------------------------------------
+ //install a version of git which is compatible with the release-plugin (e.g. v1.8.3.2)
+ git checkout -b tamaya-[release version]
+
+ export MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=200m"
+ mvn release:prepare -DdryRun=true
+
+ //copy prepared workspace (to continue faster if an upload fails in the next step)
+----------------------------------------
+
+* If something fails you may _reset_ the release branch, switch to the master branch,
+ fix whatever is needed and rebase your release branch to accomodate 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]
+----------------------------------------
+ //hint: do not use -DdryRun=true -- since it can break the next step
+ export MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=200m"
+ mvn release:perform
+
+ // !!!check the created commits including user-name and email
+
+ // login to https://repository.apache.org/ and go to "Staging Repositories"
+ // check esp. .../org/apache/tamaya/tamaya/[version]/tamaya-[version]-source-release.zip
+ // close the repository
+
+ // push the release-branch and tag to a third-party git repo
+ git remote add vote https://github.com/[user]/tamaya-vote
+ git push -u vote master
+ git push vote tamaya-[release version]
+ git push vote --tags
+----------------------------------------
+
+
+== Start the vote
+
+[listing,text]
+----------------------------------------
+ [VOTE] Release of Apache DeltaSpike [version]
+
+
+ Hi,
+
+ I was running the needed tasks to get the [version] release of Apache Tamaya out.
+ The artifacts are deployed to Nexus [1] (and [2]).
+
+ The tag is available at [3] and will get pushed to the ASF repository once the vote passed.
+
+ Please take a look at the artifacts and vote!
+
+ Please note:
+ This vote is "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..............
+ ------------------------------------------------
+
+ Thanks,
+ [name]
+
+ [1] https://repository.apache.org/content/repositories/...
+ [2] https://repository.apache.org/content/repositories/.../org/apache/tamaya/tamaya/[version]/tamaya-[version]-source-release.zip
+ [3] https://github.com/[user]/tamaya-vote/tree/tamaya-[version]
+ [4] http://www.apache.org/foundation/voting.html#ReleaseVotes
+----------------------------------------
+
+* Announce the Vote
+ ** Create a 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.
+
+[listing,text]
+----------------------------------------
+ [Result] (was: Re: [VOTE] Release of Apache Tamaya [version])
+
+ thank you for voting!
+
+ X binding +1 votes (pmc):
+ [list]
+
+ Y non-binding +1 votes:
+ [list]
+
+ Z -1 votes
+ [list]
+----------------------------------------
+
+
+== Perform the release
+
+If the binding majority approved the vote continue:
+git status
+* Login to https://repository.apache.org/ and release the repository
+
+* Merge release branch into master and push the branch and tag to the ASF repository.
+ Always do a merge in this case (not a rebase):
+
+[listing,text]
+----------------------------------------
+ git checkout master
+ git merge tamaya-[version]
+ git push origin tamaya-[version]
+ git push origin master
+----------------------------------------
+
+* Close the release and corresponding tickets at JIRA
+
+* Wait some minutes and check `http://repo2.maven.org/maven2/org/apache/tamaya`
+
+* Upload the distribution Artifacts
+
+[listing,text]
+----------------------------------------
+ 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]/
+----------------------------------------
+
+
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/285ec8d7/docs/src/main/asciidoc/releaseguide/readme.md
----------------------------------------------------------------------
diff --git a/docs/src/main/asciidoc/releaseguide/readme.md b/docs/src/main/asciidoc/releaseguide/readme.md
deleted file mode 100644
index 5932935..0000000
--- a/docs/src/main/asciidoc/releaseguide/readme.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# Release Guide of Apache Tamaya (incubating)
-
-This directory contains the release guide of Apache Tamaya (incubating).
Re: incubator-tamaya git commit: Added release guide.
Posted by Anatole Tresch <at...@gmail.com>.
Hi John
I just followed to DS guidelines. For me not an issue, since I
probably will rebuilt the release once more later, I can correct this
with ease...
J
Anatole
2016-03-16 11:53 GMT+01:00 John D. Ament <jo...@apache.org>:
> I see a couple of "DeltaSpike" in that mix.
>
> TBH, the pushing of a branch to someone's github repo isn't quite good.
> Most releases are voted on within the ASF repo, but in their own branch.
> Once the vote passes, bring that branch into master.
>
> Nothing wrong with it, just haven't seen a github based vote come up in a
> while.
>
> John
>
> On Tue, Mar 15, 2016 at 10:54 AM <an...@apache.org> wrote:
>
>> Repository: incubator-tamaya
>> Updated Branches:
>> refs/heads/master 5a5d637cb -> 285ec8d75
>>
>>
>> Added release guide.
>>
>>
>> Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/repo
>> Commit:
>> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/commit/285ec8d7
>> Tree:
>> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/tree/285ec8d7
>> Diff:
>> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/diff/285ec8d7
>>
>> Branch: refs/heads/master
>> Commit: 285ec8d7548241e12a97c6c6c5ac8a93277e9a6e
>> Parents: 5a5d637
>> Author: anatole <an...@apache.org>
>> Authored: Tue Mar 15 15:41:31 2016 +0100
>> Committer: anatole <an...@apache.org>
>> Committed: Tue Mar 15 15:41:31 2016 +0100
>>
>> ----------------------------------------------------------------------
>> .../asciidoc/releaseguide/ReleaseGuide.adoc | 230 +++++++++++++++++++
>> docs/src/main/asciidoc/releaseguide/readme.md | 3 -
>> 2 files changed, 230 insertions(+), 3 deletions(-)
>> ----------------------------------------------------------------------
>>
>>
>>
>> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/285ec8d7/docs/src/main/asciidoc/releaseguide/ReleaseGuide.adoc
>> ----------------------------------------------------------------------
>> diff --git a/docs/src/main/asciidoc/releaseguide/ReleaseGuide.adoc
>> b/docs/src/main/asciidoc/releaseguide/ReleaseGuide.adoc
>> new file mode 100644
>> index 0000000..c7df7ca
>> --- /dev/null
>> +++ b/docs/src/main/asciidoc/releaseguide/ReleaseGuide.adoc
>> @@ -0,0 +1,230 @@
>> +# Release Guide of Apache Tamaya (incubating)
>> +
>> +This directory contains the release guide of Apache Tamaya (incubating).
>> +=======
>> +Apache Tamaya -- Release Guide
>> +==============================
>> +:name: Tamaya
>> +:title: Apache Tamaya Release Guide
>> +:revnumber: 0.1-SNAPSHOT
>> +:revremark: Incubator
>> +:revdate: March 2016
>> +:longversion: {revnumber} ({revremark}) {revdate}
>> +:authorinitials: ATR
>> +:author: Anatole Tresch
>> +:email: <an...@apache.org>
>> +:source-highlighter: coderay
>> +:website: http://tamaya.incubator.apache.org/
>> +:toc:
>> +:toc-placement: manual
>> +:encoding: UTF-8
>> +:numbered:
>> +// Licensed to the Apache Software Foundation (ASF) under one
>> +// or more contributor license agreements. See the NOTICE file
>> +// distributed with this work for additional information
>> +// regarding copyright ownership. The ASF licenses this file
>> +// to you under the Apache License, Version 2.0 (the
>> +// "License"); you may not use this file except in compliance
>> +// with the License. You may obtain a copy of the License at
>> +//
>> +// http://www.apache.org/licenses/LICENSE-2.0
>> +//
>> +// Unless required by applicable law or agreed to in writing,
>> +// software distributed under the License is distributed on an
>> +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
>> +// KIND, either express or implied. See the License for the
>> +// specific language governing permissions and limitations
>> +// under the License.
>> +'''
>> +
>> +<<<
>> +
>> +image::
>> http://tamaya.incubator.apache.org/resources/images/logos/logo_wood.png[]
>> +
>> +toc::[]
>> +
>> +<<<
>> +:numbered!:
>> +-----------------------------------------------------------
>> +Licensed to the Apache Software Foundation (ASF) under one
>> +or more contributor license agreements. See the NOTICE file
>> +distributed with this work for additional information
>> +regarding copyright ownership. The ASF licenses this file
>> +to you under the Apache License, Version 2.0 (the
>> +"License"); you may not use this file except in compliance
>> +with the License. You may obtain a copy of the License at
>> +
>> + http://www.apache.org/licenses/LICENSE-2.0
>> +
>> +Unless required by applicable law or agreed to in writing,
>> +software distributed under the License is distributed on an
>> +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
>> +KIND, either express or implied. See the License for the
>> +specific language governing permissions and limitations
>> +under the License.
>> +-----------------------------------------------------------
>> +
>> +:numbered:
>> +
>> +
>> +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.
>> +
>> +
>> +== Tell the others you would proceed with the release procedure
>> +
>> +[listing,text]
>> +----------------------------------------
>> + first steps for the next release
>> +
>> + hi @ 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.
>> +
>> + regards,
>> + [name]
>> +----------------------------------------
>> +
>> +
>> +== 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.
>> +
>> +
>> +== 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:
>> +
>> +[listing,text]
>> +----------------------------------------
>> + //install a version of git which is compatible with the
>> release-plugin (e.g. v1.8.3.2)
>> + git checkout -b tamaya-[release version]
>> +
>> + export MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=200m"
>> + mvn release:prepare -DdryRun=true
>> +
>> + //copy prepared workspace (to continue faster if an upload fails in
>> the next step)
>> +----------------------------------------
>> +
>> +* If something fails you may _reset_ the release branch, switch to the
>> master branch,
>> + fix whatever is needed and rebase your release branch to accomodate 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]
>> +----------------------------------------
>> + //hint: do not use -DdryRun=true -- since it can break the next step
>> + export MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=200m"
>> + mvn release:perform
>> +
>> + // !!!check the created commits including user-name and email
>> +
>> + // login to https://repository.apache.org/ and go to "Staging
>> Repositories"
>> + // check esp.
>> .../org/apache/tamaya/tamaya/[version]/tamaya-[version]-source-release.zip
>> + // close the repository
>> +
>> + // push the release-branch and tag to a third-party git repo
>> + git remote add vote https://github.com/[user]/tamaya-vote
>> + git push -u vote master
>> + git push vote tamaya-[release version]
>> + git push vote --tags
>> +----------------------------------------
>> +
>> +
>> +== Start the vote
>> +
>> +[listing,text]
>> +----------------------------------------
>> + [VOTE] Release of Apache DeltaSpike [version]
>> +
>> +
>> + Hi,
>> +
>> + I was running the needed tasks to get the [version] release of Apache
>> Tamaya out.
>> + The artifacts are deployed to Nexus [1] (and [2]).
>> +
>> + The tag is available at [3] and will get pushed to the ASF repository
>> once the vote passed.
>> +
>> + Please take a look at the artifacts and vote!
>> +
>> + Please note:
>> + This vote is "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..............
>> + ------------------------------------------------
>> +
>> + Thanks,
>> + [name]
>> +
>> + [1] https://repository.apache.org/content/repositories/...
>> + [2]
>> https://repository.apache.org/content/repositories/.../org/apache/tamaya/tamaya/[version]/tamaya-[version]-source-release.zip
>> + [3] https://github.com/[user]/tamaya-vote/tree/tamaya-[version]
>> + [4] http://www.apache.org/foundation/voting.html#ReleaseVotes
>> +----------------------------------------
>> +
>> +* Announce the Vote
>> + ** Create a 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.
>> +
>> +[listing,text]
>> +----------------------------------------
>> + [Result] (was: Re: [VOTE] Release of Apache Tamaya [version])
>> +
>> + thank you for voting!
>> +
>> + X binding +1 votes (pmc):
>> + [list]
>> +
>> + Y non-binding +1 votes:
>> + [list]
>> +
>> + Z -1 votes
>> + [list]
>> +----------------------------------------
>> +
>> +
>> +== Perform the release
>> +
>> +If the binding majority approved the vote continue:
>> +git status
>> +* Login to https://repository.apache.org/ and release the repository
>> +
>> +* Merge release branch into master and push the branch and tag to the ASF
>> repository.
>> + Always do a merge in this case (not a rebase):
>> +
>> +[listing,text]
>> +----------------------------------------
>> + git checkout master
>> + git merge tamaya-[version]
>> + git push origin tamaya-[version]
>> + git push origin master
>> +----------------------------------------
>> +
>> +* Close the release and corresponding tickets at JIRA
>> +
>> +* Wait some minutes and check `
>> http://repo2.maven.org/maven2/org/apache/tamaya`
>> <http://repo2.maven.org/maven2/org/apache/tamaya>
>> +
>> +* Upload the distribution Artifacts
>> +
>> +[listing,text]
>> +----------------------------------------
>> + 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]/
>> +----------------------------------------
>> +
>> +
>>
>>
>> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/285ec8d7/docs/src/main/asciidoc/releaseguide/readme.md
>> ----------------------------------------------------------------------
>> diff --git a/docs/src/main/asciidoc/releaseguide/readme.md
>> b/docs/src/main/asciidoc/releaseguide/readme.md
>> deleted file mode 100644
>> index 5932935..0000000
>> --- a/docs/src/main/asciidoc/releaseguide/readme.md
>> +++ /dev/null
>> @@ -1,3 +0,0 @@
>> -# Release Guide of Apache Tamaya (incubating)
>> -
>> -This directory contains the release guide of Apache Tamaya (incubating).
>>
>>
--
Anatole Tresch
Java Engineer & Architect, JSR Spec Lead
Glärnischweg 10
CH - 8620 Wetzikon
Switzerland, Europe Zurich, GMT+1
Twitter: @atsticks
Blogs: http://javaremarkables.blogspot.ch/
Google: atsticks
Mobile +41-76 344 62 79
Re: incubator-tamaya git commit: Added release guide.
Posted by "John D. Ament" <jo...@apache.org>.
I see a couple of "DeltaSpike" in that mix.
TBH, the pushing of a branch to someone's github repo isn't quite good.
Most releases are voted on within the ASF repo, but in their own branch.
Once the vote passes, bring that branch into master.
Nothing wrong with it, just haven't seen a github based vote come up in a
while.
John
On Tue, Mar 15, 2016 at 10:54 AM <an...@apache.org> wrote:
> Repository: incubator-tamaya
> Updated Branches:
> refs/heads/master 5a5d637cb -> 285ec8d75
>
>
> Added release guide.
>
>
> Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/repo
> Commit:
> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/commit/285ec8d7
> Tree:
> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/tree/285ec8d7
> Diff:
> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/diff/285ec8d7
>
> Branch: refs/heads/master
> Commit: 285ec8d7548241e12a97c6c6c5ac8a93277e9a6e
> Parents: 5a5d637
> Author: anatole <an...@apache.org>
> Authored: Tue Mar 15 15:41:31 2016 +0100
> Committer: anatole <an...@apache.org>
> Committed: Tue Mar 15 15:41:31 2016 +0100
>
> ----------------------------------------------------------------------
> .../asciidoc/releaseguide/ReleaseGuide.adoc | 230 +++++++++++++++++++
> docs/src/main/asciidoc/releaseguide/readme.md | 3 -
> 2 files changed, 230 insertions(+), 3 deletions(-)
> ----------------------------------------------------------------------
>
>
>
> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/285ec8d7/docs/src/main/asciidoc/releaseguide/ReleaseGuide.adoc
> ----------------------------------------------------------------------
> diff --git a/docs/src/main/asciidoc/releaseguide/ReleaseGuide.adoc
> b/docs/src/main/asciidoc/releaseguide/ReleaseGuide.adoc
> new file mode 100644
> index 0000000..c7df7ca
> --- /dev/null
> +++ b/docs/src/main/asciidoc/releaseguide/ReleaseGuide.adoc
> @@ -0,0 +1,230 @@
> +# Release Guide of Apache Tamaya (incubating)
> +
> +This directory contains the release guide of Apache Tamaya (incubating).
> +=======
> +Apache Tamaya -- Release Guide
> +==============================
> +:name: Tamaya
> +:title: Apache Tamaya Release Guide
> +:revnumber: 0.1-SNAPSHOT
> +:revremark: Incubator
> +:revdate: March 2016
> +:longversion: {revnumber} ({revremark}) {revdate}
> +:authorinitials: ATR
> +:author: Anatole Tresch
> +:email: <an...@apache.org>
> +:source-highlighter: coderay
> +:website: http://tamaya.incubator.apache.org/
> +:toc:
> +:toc-placement: manual
> +:encoding: UTF-8
> +:numbered:
> +// Licensed to the Apache Software Foundation (ASF) under one
> +// or more contributor license agreements. See the NOTICE file
> +// distributed with this work for additional information
> +// regarding copyright ownership. The ASF licenses this file
> +// to you under the Apache License, Version 2.0 (the
> +// "License"); you may not use this file except in compliance
> +// with the License. You may obtain a copy of the License at
> +//
> +// http://www.apache.org/licenses/LICENSE-2.0
> +//
> +// Unless required by applicable law or agreed to in writing,
> +// software distributed under the License is distributed on an
> +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
> +// KIND, either express or implied. See the License for the
> +// specific language governing permissions and limitations
> +// under the License.
> +'''
> +
> +<<<
> +
> +image::
> http://tamaya.incubator.apache.org/resources/images/logos/logo_wood.png[]
> +
> +toc::[]
> +
> +<<<
> +:numbered!:
> +-----------------------------------------------------------
> +Licensed to the Apache Software Foundation (ASF) under one
> +or more contributor license agreements. See the NOTICE file
> +distributed with this work for additional information
> +regarding copyright ownership. The ASF licenses this file
> +to you under the Apache License, Version 2.0 (the
> +"License"); you may not use this file except in compliance
> +with the License. You may obtain a copy of the License at
> +
> + http://www.apache.org/licenses/LICENSE-2.0
> +
> +Unless required by applicable law or agreed to in writing,
> +software distributed under the License is distributed on an
> +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
> +KIND, either express or implied. See the License for the
> +specific language governing permissions and limitations
> +under the License.
> +-----------------------------------------------------------
> +
> +:numbered:
> +
> +
> +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.
> +
> +
> +== Tell the others you would proceed with the release procedure
> +
> +[listing,text]
> +----------------------------------------
> + first steps for the next release
> +
> + hi @ 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.
> +
> + regards,
> + [name]
> +----------------------------------------
> +
> +
> +== 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.
> +
> +
> +== 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:
> +
> +[listing,text]
> +----------------------------------------
> + //install a version of git which is compatible with the
> release-plugin (e.g. v1.8.3.2)
> + git checkout -b tamaya-[release version]
> +
> + export MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=200m"
> + mvn release:prepare -DdryRun=true
> +
> + //copy prepared workspace (to continue faster if an upload fails in
> the next step)
> +----------------------------------------
> +
> +* If something fails you may _reset_ the release branch, switch to the
> master branch,
> + fix whatever is needed and rebase your release branch to accomodate 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]
> +----------------------------------------
> + //hint: do not use -DdryRun=true -- since it can break the next step
> + export MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=200m"
> + mvn release:perform
> +
> + // !!!check the created commits including user-name and email
> +
> + // login to https://repository.apache.org/ and go to "Staging
> Repositories"
> + // check esp.
> .../org/apache/tamaya/tamaya/[version]/tamaya-[version]-source-release.zip
> + // close the repository
> +
> + // push the release-branch and tag to a third-party git repo
> + git remote add vote https://github.com/[user]/tamaya-vote
> + git push -u vote master
> + git push vote tamaya-[release version]
> + git push vote --tags
> +----------------------------------------
> +
> +
> +== Start the vote
> +
> +[listing,text]
> +----------------------------------------
> + [VOTE] Release of Apache DeltaSpike [version]
> +
> +
> + Hi,
> +
> + I was running the needed tasks to get the [version] release of Apache
> Tamaya out.
> + The artifacts are deployed to Nexus [1] (and [2]).
> +
> + The tag is available at [3] and will get pushed to the ASF repository
> once the vote passed.
> +
> + Please take a look at the artifacts and vote!
> +
> + Please note:
> + This vote is "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..............
> + ------------------------------------------------
> +
> + Thanks,
> + [name]
> +
> + [1] https://repository.apache.org/content/repositories/...
> + [2]
> https://repository.apache.org/content/repositories/.../org/apache/tamaya/tamaya/[version]/tamaya-[version]-source-release.zip
> + [3] https://github.com/[user]/tamaya-vote/tree/tamaya-[version]
> + [4] http://www.apache.org/foundation/voting.html#ReleaseVotes
> +----------------------------------------
> +
> +* Announce the Vote
> + ** Create a 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.
> +
> +[listing,text]
> +----------------------------------------
> + [Result] (was: Re: [VOTE] Release of Apache Tamaya [version])
> +
> + thank you for voting!
> +
> + X binding +1 votes (pmc):
> + [list]
> +
> + Y non-binding +1 votes:
> + [list]
> +
> + Z -1 votes
> + [list]
> +----------------------------------------
> +
> +
> +== Perform the release
> +
> +If the binding majority approved the vote continue:
> +git status
> +* Login to https://repository.apache.org/ and release the repository
> +
> +* Merge release branch into master and push the branch and tag to the ASF
> repository.
> + Always do a merge in this case (not a rebase):
> +
> +[listing,text]
> +----------------------------------------
> + git checkout master
> + git merge tamaya-[version]
> + git push origin tamaya-[version]
> + git push origin master
> +----------------------------------------
> +
> +* Close the release and corresponding tickets at JIRA
> +
> +* Wait some minutes and check `
> http://repo2.maven.org/maven2/org/apache/tamaya`
> <http://repo2.maven.org/maven2/org/apache/tamaya>
> +
> +* Upload the distribution Artifacts
> +
> +[listing,text]
> +----------------------------------------
> + 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]/
> +----------------------------------------
> +
> +
>
>
> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/285ec8d7/docs/src/main/asciidoc/releaseguide/readme.md
> ----------------------------------------------------------------------
> diff --git a/docs/src/main/asciidoc/releaseguide/readme.md
> b/docs/src/main/asciidoc/releaseguide/readme.md
> deleted file mode 100644
> index 5932935..0000000
> --- a/docs/src/main/asciidoc/releaseguide/readme.md
> +++ /dev/null
> @@ -1,3 +0,0 @@
> -# Release Guide of Apache Tamaya (incubating)
> -
> -This directory contains the release guide of Apache Tamaya (incubating).
>
>
Re: incubator-tamaya git commit: Added release guide.
Posted by "John D. Ament" <jo...@apache.org>.
I see a couple of "DeltaSpike" in that mix.
TBH, the pushing of a branch to someone's github repo isn't quite good.
Most releases are voted on within the ASF repo, but in their own branch.
Once the vote passes, bring that branch into master.
Nothing wrong with it, just haven't seen a github based vote come up in a
while.
John
On Tue, Mar 15, 2016 at 10:54 AM <an...@apache.org> wrote:
> Repository: incubator-tamaya
> Updated Branches:
> refs/heads/master 5a5d637cb -> 285ec8d75
>
>
> Added release guide.
>
>
> Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/repo
> Commit:
> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/commit/285ec8d7
> Tree:
> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/tree/285ec8d7
> Diff:
> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/diff/285ec8d7
>
> Branch: refs/heads/master
> Commit: 285ec8d7548241e12a97c6c6c5ac8a93277e9a6e
> Parents: 5a5d637
> Author: anatole <an...@apache.org>
> Authored: Tue Mar 15 15:41:31 2016 +0100
> Committer: anatole <an...@apache.org>
> Committed: Tue Mar 15 15:41:31 2016 +0100
>
> ----------------------------------------------------------------------
> .../asciidoc/releaseguide/ReleaseGuide.adoc | 230 +++++++++++++++++++
> docs/src/main/asciidoc/releaseguide/readme.md | 3 -
> 2 files changed, 230 insertions(+), 3 deletions(-)
> ----------------------------------------------------------------------
>
>
>
> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/285ec8d7/docs/src/main/asciidoc/releaseguide/ReleaseGuide.adoc
> ----------------------------------------------------------------------
> diff --git a/docs/src/main/asciidoc/releaseguide/ReleaseGuide.adoc
> b/docs/src/main/asciidoc/releaseguide/ReleaseGuide.adoc
> new file mode 100644
> index 0000000..c7df7ca
> --- /dev/null
> +++ b/docs/src/main/asciidoc/releaseguide/ReleaseGuide.adoc
> @@ -0,0 +1,230 @@
> +# Release Guide of Apache Tamaya (incubating)
> +
> +This directory contains the release guide of Apache Tamaya (incubating).
> +=======
> +Apache Tamaya -- Release Guide
> +==============================
> +:name: Tamaya
> +:title: Apache Tamaya Release Guide
> +:revnumber: 0.1-SNAPSHOT
> +:revremark: Incubator
> +:revdate: March 2016
> +:longversion: {revnumber} ({revremark}) {revdate}
> +:authorinitials: ATR
> +:author: Anatole Tresch
> +:email: <an...@apache.org>
> +:source-highlighter: coderay
> +:website: http://tamaya.incubator.apache.org/
> +:toc:
> +:toc-placement: manual
> +:encoding: UTF-8
> +:numbered:
> +// Licensed to the Apache Software Foundation (ASF) under one
> +// or more contributor license agreements. See the NOTICE file
> +// distributed with this work for additional information
> +// regarding copyright ownership. The ASF licenses this file
> +// to you under the Apache License, Version 2.0 (the
> +// "License"); you may not use this file except in compliance
> +// with the License. You may obtain a copy of the License at
> +//
> +// http://www.apache.org/licenses/LICENSE-2.0
> +//
> +// Unless required by applicable law or agreed to in writing,
> +// software distributed under the License is distributed on an
> +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
> +// KIND, either express or implied. See the License for the
> +// specific language governing permissions and limitations
> +// under the License.
> +'''
> +
> +<<<
> +
> +image::
> http://tamaya.incubator.apache.org/resources/images/logos/logo_wood.png[]
> +
> +toc::[]
> +
> +<<<
> +:numbered!:
> +-----------------------------------------------------------
> +Licensed to the Apache Software Foundation (ASF) under one
> +or more contributor license agreements. See the NOTICE file
> +distributed with this work for additional information
> +regarding copyright ownership. The ASF licenses this file
> +to you under the Apache License, Version 2.0 (the
> +"License"); you may not use this file except in compliance
> +with the License. You may obtain a copy of the License at
> +
> + http://www.apache.org/licenses/LICENSE-2.0
> +
> +Unless required by applicable law or agreed to in writing,
> +software distributed under the License is distributed on an
> +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
> +KIND, either express or implied. See the License for the
> +specific language governing permissions and limitations
> +under the License.
> +-----------------------------------------------------------
> +
> +:numbered:
> +
> +
> +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.
> +
> +
> +== Tell the others you would proceed with the release procedure
> +
> +[listing,text]
> +----------------------------------------
> + first steps for the next release
> +
> + hi @ 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.
> +
> + regards,
> + [name]
> +----------------------------------------
> +
> +
> +== 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.
> +
> +
> +== 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:
> +
> +[listing,text]
> +----------------------------------------
> + //install a version of git which is compatible with the
> release-plugin (e.g. v1.8.3.2)
> + git checkout -b tamaya-[release version]
> +
> + export MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=200m"
> + mvn release:prepare -DdryRun=true
> +
> + //copy prepared workspace (to continue faster if an upload fails in
> the next step)
> +----------------------------------------
> +
> +* If something fails you may _reset_ the release branch, switch to the
> master branch,
> + fix whatever is needed and rebase your release branch to accomodate 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]
> +----------------------------------------
> + //hint: do not use -DdryRun=true -- since it can break the next step
> + export MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=200m"
> + mvn release:perform
> +
> + // !!!check the created commits including user-name and email
> +
> + // login to https://repository.apache.org/ and go to "Staging
> Repositories"
> + // check esp.
> .../org/apache/tamaya/tamaya/[version]/tamaya-[version]-source-release.zip
> + // close the repository
> +
> + // push the release-branch and tag to a third-party git repo
> + git remote add vote https://github.com/[user]/tamaya-vote
> + git push -u vote master
> + git push vote tamaya-[release version]
> + git push vote --tags
> +----------------------------------------
> +
> +
> +== Start the vote
> +
> +[listing,text]
> +----------------------------------------
> + [VOTE] Release of Apache DeltaSpike [version]
> +
> +
> + Hi,
> +
> + I was running the needed tasks to get the [version] release of Apache
> Tamaya out.
> + The artifacts are deployed to Nexus [1] (and [2]).
> +
> + The tag is available at [3] and will get pushed to the ASF repository
> once the vote passed.
> +
> + Please take a look at the artifacts and vote!
> +
> + Please note:
> + This vote is "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..............
> + ------------------------------------------------
> +
> + Thanks,
> + [name]
> +
> + [1] https://repository.apache.org/content/repositories/...
> + [2]
> https://repository.apache.org/content/repositories/.../org/apache/tamaya/tamaya/[version]/tamaya-[version]-source-release.zip
> + [3] https://github.com/[user]/tamaya-vote/tree/tamaya-[version]
> + [4] http://www.apache.org/foundation/voting.html#ReleaseVotes
> +----------------------------------------
> +
> +* Announce the Vote
> + ** Create a 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.
> +
> +[listing,text]
> +----------------------------------------
> + [Result] (was: Re: [VOTE] Release of Apache Tamaya [version])
> +
> + thank you for voting!
> +
> + X binding +1 votes (pmc):
> + [list]
> +
> + Y non-binding +1 votes:
> + [list]
> +
> + Z -1 votes
> + [list]
> +----------------------------------------
> +
> +
> +== Perform the release
> +
> +If the binding majority approved the vote continue:
> +git status
> +* Login to https://repository.apache.org/ and release the repository
> +
> +* Merge release branch into master and push the branch and tag to the ASF
> repository.
> + Always do a merge in this case (not a rebase):
> +
> +[listing,text]
> +----------------------------------------
> + git checkout master
> + git merge tamaya-[version]
> + git push origin tamaya-[version]
> + git push origin master
> +----------------------------------------
> +
> +* Close the release and corresponding tickets at JIRA
> +
> +* Wait some minutes and check `
> http://repo2.maven.org/maven2/org/apache/tamaya`
> <http://repo2.maven.org/maven2/org/apache/tamaya>
> +
> +* Upload the distribution Artifacts
> +
> +[listing,text]
> +----------------------------------------
> + 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]/
> +----------------------------------------
> +
> +
>
>
> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/285ec8d7/docs/src/main/asciidoc/releaseguide/readme.md
> ----------------------------------------------------------------------
> diff --git a/docs/src/main/asciidoc/releaseguide/readme.md
> b/docs/src/main/asciidoc/releaseguide/readme.md
> deleted file mode 100644
> index 5932935..0000000
> --- a/docs/src/main/asciidoc/releaseguide/readme.md
> +++ /dev/null
> @@ -1,3 +0,0 @@
> -# Release Guide of Apache Tamaya (incubating)
> -
> -This directory contains the release guide of Apache Tamaya (incubating).
>
>