Author: stevel
Date: Mon Jan 4 23:08:05 2016
New Revision: 1722979
URL: http://svn.apache.org/viewvc?rev=1722979&view=rev
Log:
SLIDER-1014 code formatting problems
Modified:
incubator/slider/site/trunk/content/developing/releasing.md
Modified: incubator/slider/site/trunk/content/developing/releasing.md
URL:
http://svn.apache.org/viewvc/incubator/slider/site/trunk/content/developing/releasing.md?rev=1722979&r1=1722978&r2=1722979&view=diff
==============================================================================
--- incubator/slider/site/trunk/content/developing/releasing.md (original)
+++ incubator/slider/site/trunk/content/developing/releasing.md Mon Jan 4
23:08:05 2016
@@ -168,59 +168,30 @@ anyway.
In `~/.m2/settings.xml`:
<settings>
-
- ...
-
<servers>
-
<!-- To publish a snapshot-->
-
<server>
-
<id>apache.snapshots.https</id>
-
<username>YOUR_ASF_USERNAME</username>
-
<password>YOUR_SECRET_PASSWORD</password>
-
<server>
-
<id>apache.snapshots.https</id>
-
<username>YOUR_ASF_USERNAME</username>
-
<password>YOUR_SECRET_PASSWORD</password>
-
</server>
-
<!-- To stage a release -->
-
<server>
-
<id>apache.staging.https</id>
-
<username>YOUR_ASF_USERNAME</username>
-
<password>YOUR_SECRET_PASSWORD</password>
-
</server>
-
<!-- To finalise the release-->
-
<server>
-
<id>apache.releases.https</id>
-
<username>YOUR_ASF_USERNAME</username>
-
<password>YOUR_SECRET_PASSWORD</password>
-
</server>
-
</servers>
-
- ...
-
</settings>
@@ -238,15 +209,11 @@ Once an RC is voted in, it can be rename
To begin, you need to check out the SVN repository somewhere
-```
-https://dist.apache.org/repos/dist/release/incubator/slider
-```
+ https://dist.apache.org/repos/dist/release/incubator/slider
Set the release property `svn.publish.dir` to this value
-```
-svn.publish.dir=/Users/stevel/Java/Apache/slider-dist
-```
+ svn.publish.dir=/Users/stevel/Java/Apache/slider-dist
### Make sure your PGP signature is in `slider-dist/KEYS`
@@ -270,14 +237,12 @@ Wait until there are none shown in the U
Create a file `../release.properties` âthat is, one directory
above the source tree you are using. (That's to keep the source tree
uncontaminated)
-```
-slider.release.branch=branches/branch-0.9
-slider.release.version=0.90.2-incubating
-slider.develop.version=0.91.0-incubating-SNAPSHOT
-release.jira=SLIDER-1014
-release.rc.suffix=-RC0
-svn.publish.dir=~/svn/slider-dist
-```
+ slider.release.branch=branches/branch-0.9
+ slider.release.version=0.90.2-incubating
+ slider.develop.version=0.91.0-incubating-SNAPSHOT
+ release.jira=SLIDER-1014
+ release.rc.suffix=-RC0
+ svn.publish.dir=~/svn/slider-dist
## Create the release in JIRA
@@ -301,9 +266,7 @@ Slider project on JIRA. If you are not:
set the release property `release.jira.version` to the version field
-```
-release.jira.version=12334370
-```
+ release.jira.version=12334370
It may seem premature to mark the release as complete,
but our process closes it early so that the changes page is generated.
@@ -333,9 +296,7 @@ The multi-line release notes should go i
The `init` target loads in the properties, builds up some new values
and displays them.
-```
-ant -f bin/release.xml init
-```
+ ant -f bin/release.xml init
### Verify the license of dependent artifacts
@@ -345,9 +306,7 @@ For modules which publish JARs (`slider-
run the third party check for JARs. If you run this at the top level project
it will do it for the relevant sub projects.
-```
-ant -f bin/release.xml license-check
-```
+ ant -f bin/release.xml license-check
This will build everything then generate license files under each module in
`target/generated-sources/license/THIRD-PARTY.txt`. Inspect it and make sure
@@ -361,29 +320,23 @@ has an entry for every dependency withou
### Update the maven artifact version to that of the new release
-```
-ant -f bin/release.xml set-to-release-version
-ant -f bin/release.xml git-commit git-push -Dgit.commit.text="updating to
release version"
-```
+ ant -f bin/release.xml set-to-release-version
+ ant -f bin/release.xml git-commit git-push -Dgit.commit.text="updating to
release version"
### Create the release branch
Create the release branch and push it to the apache repository:
-```
-ant -f bin/release.xml git-create-release-branch
-```
+ ant -f bin/release.xml git-create-release-branch
This branch is where all the release work will take place. That can include
patching and cherry-picking from the development branch.
### Return to the develop branch and increment its version
-```
-ant -f bin/release.xml git-switch-develop-branch set-to-new-develop-version
-ant -f bin/release.xml git-commit -Dgit.commit.text="updating to new develop
version"
-ant -f bin/release.xml git-push
-```
+ ant -f bin/release.xml git-switch-develop-branch set-to-new-develop-version
+ ant -f bin/release.xml git-commit -Dgit.commit.text="updating to new
develop version"
+ ant -f bin/release.xml git-push
At this point the slider version in `develop/` is that for ongoing development;
that in the new release branch set to the release version. The git history
@@ -396,9 +349,7 @@ to the release version is a commit share
Adjacent to your normal development directory, check out a new copy of slider
-```
-git clone https://git-wip-us.apache.org/repos/asf/incubator-slider.git
slider-release
-```
+ git clone https://git-wip-us.apache.org/repos/asf/incubator-slider.git
slider-release
This ensures that there are no .git-ignored files in the source tree,
files which may end up in the source distribution.
@@ -414,10 +365,8 @@ In `slider-release`, Check out the speci
Example
-```
-cd slider-release
-git checkout -t origin/branches/branch-0.9
-```
+ cd slider-release
+ git checkout -t origin/branches/branch-0.9
*For the test of this document, all instructions are to be executed in the
this `slider-release`
directory, in the release branch.*
@@ -425,32 +374,24 @@ directory, in the release branch.*
### Build and Release to Nexus and SVN
-```
-ant -f bin/release.xml clean release
-```
+ ant -f bin/release.xml clean release
Follow the instructions printed for the manual steps
To see them again:
-```
-ant -f bin/release.xml print-nexus-instructions
-```
+ ant -f bin/release.xml print-nexus-instructions
The [Nexus UI](https://repository.apache.org/content/repositories/)
gives the name of the repository, such as `orgapacheslider-1010`
In `release.properties` set `nexus.staging.repository` to this value
-```
-nexus.staging.repository=orgapacheslider-1010
-```
+ nexus.staging.repository=orgapacheslider-1010
### Begin the slider-dev vote
-```
-ant -f bin/release.xml generate-vote-text
-```
+ ant -f bin/release.xml generate-vote-text
This saves the vote file to `target/vote.txt`
@@ -477,22 +418,18 @@ Await the declared time for the slider v
Add all the results as release properties
-```
-vote.result.positive.binding=0
-vote.result.zero.binding=0
-vote.result.negative.binding=0
-vote.result.negative=0
-vote.result.positive=0
-vote.result.zero=0
-```
+ vote.result.positive.binding=0
+ vote.result.zero.binding=0
+ vote.result.negative.binding=0
+ vote.result.negative=0
+ vote.result.positive=0
+ vote.result.zero=0
### Generate the result message
Generate the email to send to the developer list
-```
-ant -f bin/release.xml generate-result-message
-```
+ ant -f bin/release.xml generate-result-message
Load the text for this message from the generated file
(`target/vote-results.txt`)
and send it out.
@@ -524,16 +461,12 @@ Save this in the property `mail.vote.thr
Example:
-```
-mail.vote.thread=http://mail-archives.apache.org/mod_mbox/incubator-slider-dev/201512.mbox/%3C7EBD312A-E115-4A99-AAE7-1BF553E3B28D%40hortonworks.com%3E
-mail.vote.result.thread=http://mail-archives.apache.org/mod_mbox/incubator-slider-dev/201601.mbox/%3CC28233B7-9016-44F4-9A6B-1EBC8BFCDF08%40hortonworks.com%3E
-```
+
mail.vote.thread=http://mail-archives.apache.org/mod_mbox/incubator-slider-dev/201512.mbox/%3C7EBD312A-E115-4A99-AAE7-1BF553E3B28D%40hortonworks.com%3E
+
mail.vote.result.thread=http://mail-archives.apache.org/mod_mbox/incubator-slider-dev/201601.mbox/%3CC28233B7-9016-44F4-9A6B-1EBC8BFCDF08%40hortonworks.com%3E
Build the incubator vote into the text file, `target/vote-incubator.txt`
-```
-ant -f bin/release.xml generate-incubator-vote
-```
+ ant -f bin/release.xml generate-incubator-vote
Use this file as the basis of an email to the incubator general list.
@@ -544,17 +477,13 @@ if a binding Incubator PMC (IPMC) member
Record the vote into `vote.incubator.result.` release properties:
-```
-vote.incubator.result.positive.binding=0
-vote.incubator.result.zero.binding=0
-vote.incubator.result.negative.binding=0
-```
+ vote.incubator.result.positive.binding=0
+ vote.incubator.result.zero.binding=0
+ vote.incubator.result.negative.binding=0
Then create the release message
-```
-ant -f bin/release.xml generate-incubator-result-message
-```
+ ant -f bin/release.xml generate-incubator-result-message
This build target will fail if there were any binding -1 votes or not
enough positive votes.
@@ -569,9 +498,7 @@ If the vote failed,
### Commit the final svn release
Assuming the vote succeeded, you can now commit the artifacts
-```
-ant -f bin/release.xml svn-release-final-artifacts
-```
+ ant -f bin/release.xml svn-release-final-artifacts
### Release the staged Nexus artifacts
@@ -589,9 +516,7 @@ The released artifacts may take up to 24
The probe for these artifacts is:
-```
-ant -f bin/release.xml check-release-urls
-```
+ ant -f bin/release.xml check-release-urls
Only once it has succeeded can the announcement be made
@@ -601,9 +526,7 @@ The released artifacts may take up to 24
Generate the release message:
-```
-ant -f bin/release.xml generate-announcement-message
-```
+ ant -f bin/release.xml generate-announcement-message
Then follow the instructions on where to email it.
@@ -624,28 +547,26 @@ After any changes, [trigger a site rebui
Log the time, close the issue.
-### Example `../release.properties`
+### Example release.properties file
Here is the final `release.properties` file from the 0.90.2 release
-```
-slider.release.version=0.90.2-incubating
-slider.develop.version=0.91.0-incubating-SNAPSHOT
-release.jira=SLIDER-1014
-release.jira.version=12334370
-release.rc.suffix=-RC1
-svn.publish.dir=/Users/stevel/Java/Apache/slider-dist
-
-nexus.staging.repository=orgapacheslider-1013
-git.release.branch=branches/branch-0.90
-
-vote.result.positive.binding=3
-vote.result.zero.binding=0
-vote.result.negative.binding=0
-
-mail.vote.thread=http://mail-archives.apache.org/mod_mbox/incubator-slider-dev/201512.mbox/%3C7EBD312A-E115-4A99-AAE7-1BF553E3B28D%40hortonworks.com%3E
-mail.vote.result.thread=http://mail-archives.apache.org/mod_mbox/incubator-slider-dev/201601.mbox/%3CC28233B7-9016-44F4-9A6B-1EBC8BFCDF08%40hortonworks.com%3E
-```
+ slider.release.version=0.90.2-incubating
+ slider.develop.version=0.91.0-incubating-SNAPSHOT
+ release.jira=SLIDER-1014
+ release.jira.version=12334370
+ release.rc.suffix=-RC1
+ svn.publish.dir=/Users/stevel/Java/Apache/slider-dist
+
+ nexus.staging.repository=orgapacheslider-1013
+ git.release.branch=branches/branch-0.90
+
+ vote.result.positive.binding=3
+ vote.result.zero.binding=0
+ vote.result.negative.binding=0
+
+
mail.vote.thread=http://mail-archives.apache.org/mod_mbox/incubator-slider-dev/201512.mbox/%3C7EBD312A-E115-4A99-AAE7-1BF553E3B28D%40hortonworks.com%3E
+
mail.vote.result.thread=http://mail-archives.apache.org/mod_mbox/incubator-slider-dev/201601.mbox/%3CC28233B7-9016-44F4-9A6B-1EBC8BFCDF08%40hortonworks.com%3E
### How to clean up after a failed/cancelled vote
@@ -653,7 +574,7 @@ If a vote fails you must:
1. Clean up the release artifacts in the svn distribution directory
- ant -f bin/release.xml svn-delete-rc-artifacts
+ ant -f bin/release.xml svn-delete-rc-artifacts
1. Log in to [the ASF Nexus
server](https://repository.apache.org/index.html#stagingRepositories)
1. Locate and select the staged Slider repository
@@ -673,18 +594,14 @@ the `release.xml` release file)`
ant `release.properties` property option.
This would need to be set in `build.properties` or on the command line
-```
-ant -f bin/release.xml -Drelease.properties=~/release.properties
-```
+ ant -f bin/release.xml -Drelease.properties=~/release.properties
It's easier to use a symbolic link here.
1. The slider POMs offer different profiles of Hadoop versions to build
against. The instructions
below use the default. If a profile is needed, append it to all the maven
commands.
-```
mvn.extra.args=-Prelease-2.8
-```
1. If you are not building against a stable Hadoop release
