Github user sijie commented on a diff in the pull request:
https://github.com/apache/incubator-distributedlog/pull/51#discussion_r95101716
--- Diff: website/community/release_guide.md ---
@@ -0,0 +1,507 @@
+---
+layout: default
+title: "DistributedLog Release Guide"
+permalink: /community/release-guide/
+---
+
+# Apache DistributedLog Release Guide
+
+* TOC
+{:toc}
+
+This page documents the procedure to make an Apache DistributedLog
release. Creit to the
[Beam](http://distributedlog.incubator.apache.org/contribute/release-guide/)
project. We've borrow liberally from their documentation.
+
+## Introduction
+
+The Apache DistributedLog project periodically declares and publishes
releases. A release is one or more packages of the project artifact(s) that are
approved for general public distribution and use. They may come with various
degrees of caveat regarding their perceived quality and potential for change,
such as âalphaâ, âbetaâ, âincubatingâ, âstableâ, etc.
+
+The DistributedLog community treats releases with great importance. They
are a public face of the project and most users interact with the project only
through the releases. Releases are signed off by the entire DistributedLog
community in a public vote.
+
+Each release is executed by a *Release Manager*, who is selected among the
[DistributedLog committers]({{ site.baseurl }}/community/team). This document
describes the process that the Release Manager follows to perform a release.
Any changes to this process should be discussed and adopted on the [dev@
mailing list]({{ site.baseurl }}/community/#mailing-lists).
+
+Please remember that publishing software has legal consequences. This
guide complements the foundation-wide [Product Release
Policy](http://www.apache.org/dev/release.html) and [Release Distribution
Policy](http://www.apache.org/dev/release-distribution).
+
+## Overview
+
+![Alt text]({{ "/images/release-guide-1.png" | prepend: site.baseurl }}
"Release Process"){:width="100%"}
+
+The release process consists of several steps:
+
+1. Decide to release
+1. Prepare for the release
+1. Build a release candidate
+1. Vote on the release candidate
+1. If necessary, fix any issues and go back to step 3.
+1. Finalize the release
+1. Promote the release
+
+**********
+
+## Decide to release
+
+Deciding to release and selecting a Release Manager is the first step of
the release process. This is a consensus-based decision of the entire community.
+
+Anybody can propose a release on the dev@ mailing list, giving a solid
argument and nominating a committer as the Release Manager (including
themselves). Thereâs no formal process, no vote requirements, and no timing
requirements. Any objections should be resolved by consensus before starting
the release.
+
+In general, the community prefers to have a rotating set of 3-5 Release
Managers. Keeping a small core set of managers allows enough people to build
expertise in this area and improve processes over time, without Release
Managers needing to re-learn the processes for each release. That said, if you
are a committer interested in serving the community in this way, please reach
out to the community on the dev@ mailing list.
+
+### Checklist to proceed to the next step
+
+1. Community agrees to release
+1. Community selects a Release Manager
+
+**********
+
+## Prepare for the release
+
+Before your first release, you should perform one-time configuration
steps. This will set up your security keys for signing the release and access
to various release repositories.
+
+To prepare for each release, you should audit the project status in the
JIRA issue tracker, and do necessary bookkeeping. Finally, you should create a
release branch from which individual release candidates will be built.
+
+### One-time setup instructions
+
+#### GPG Key
+
+You need to have a GPG key to sign the release artifacts. Please be aware
of the ASF-wide [release signing
guidelines](https://www.apache.org/dev/release-signing.html). If you donât
have a GPG key associated with your Apache account, please create one according
to the guidelines.
+
+Determine your Apache GPG Key and Key ID, as follows:
+
+ gpg --list-keys
+
+This will list your GPG keys. One of these should reflect your Apache
account, for example:
+
+ --------------------------------------------------
+ pub 2048R/845E6689 2016-02-23
+ uid Nomen Nescio <[email protected]>
+ sub 2048R/BA4D50BE 2016-02-23
+
+Here, the key ID is the 8-digit hex string in the `pub` line: `845E6689`.
+
+Now, add your Apache GPG key to the DistributedLogâs `KEYS` file both in
[`dev`](https://dist.apache.org/repos/dist/dev/incubator/distributedlog/KEYS)
and
[`release`](https://dist.apache.org/repos/dist/release/incubator/distributedlog/KEYS)
repositories at `dist.apache.org`. Follow the instructions listed at the top
of these files.
+
+Configure `git` to use this key when signing code by giving it your key
ID, as follows:
+
+ git config --global user.signingkey 845E6689
+
+You may drop the `--global` option if youâd prefer to use this key for
the current repository only.
+
+You may wish to start `gpg-agent` to unlock your GPG key only once using
your passphrase. Otherwise, you may need to enter this passphrase hundreds of
times. The setup for `gpg-agent` varies based on operating system, but may be
something like this:
+
+ eval $(gpg-agent --daemon --no-grab --write-env-file
$HOME/.gpg-agent-info)
+ export GPG_TTY=$(tty)
+ export GPG_AGENT_INFO
+
+#### Access to Apache Nexus repository
+
+Configure access to the [Apache Nexus
repository](http://repository.apache.org/), which enables final deployment of
releases to the Maven Central Repository.
+
+1. You log in with your Apache account.
+1. Confirm you have appropriate access by finding
`org.apache.distributedlog` under `Staging Profiles`.
+1. Navigate to your `Profile` (top right dropdown menu of the page).
+1. Choose `User Token` from the dropdown, then click `Access User Token`.
Copy a snippet of the Maven XML configuration block.
+1. Insert this snippet twice into your global Maven `settings.xml` file,
typically `${HOME}/.m2/settings.xml`. The end result should look like this,
where `TOKEN_NAME` and `TOKEN_PASSWORD` are your secret tokens:
+
+ <settings>
+ <servers>
+ <server>
+ <id>apache.releases.https</id>
+ <username>TOKEN_NAME</username>
+ <password>TOKEN_PASSWORD</password>
+ </server>
+ <server>
+ <id>apache.snapshots.https</id>
+ <username>TOKEN_NAME</username>
+ <password>TOKEN_PASSWORD</password>
+ </server>
+ </servers>
+ </settings>
+
+#### Website development setup
+
+Get ready for updating the DistributedLog website by following the
[website development instructions]({{ site.baseurl
}}/contribute/contribution-guide/#website).
+
+### Create a new version in JIRA
+
+When contributors resolve an issue in JIRA, they are tagging it with a
release that will contain their changes. With the release currently underway,
new issues should be resolved against a subsequent future release. Therefore,
you should create a release item for this subsequent release, as follows:
+
+1. In JIRA, navigate to the [`DistributedLog > Administration >
Versions`](https://issues.apache.org/jira/plugins/servlet/project-config/DL/versions).
+1. Add a new release: choose the next minor version number compared to the
one currently underway, select todayâs date as the `Start Date`, and choose
`Add`.
+
+### Triage release-blocking issues in JIRA
+
+There could be outstanding release-blocking issues, which should be
triaged before proceeding to build a release candidate. We track them by
assigning a specific `Fix version` field even before the issue resolved.
+
+The list of release-blocking issues is available at the [version status
page](https://issues.apache.org/jira/browse/DL/?selectedTab=com.atlassian.jira.jira-projects-plugin:versions-panel).
Triage each unresolved issue with one of the following resolutions:
+
+* If the issue has been resolved and JIRA was not updated, resolve it
accordingly.
+* If the issue has not been resolved and it is acceptable to defer this
until the next release, update the `Fix Version` field to the new version you
just created. Please consider discussing this with stakeholders and the dev@
mailing list, as appropriate.
+* If the issue has not been resolved and it is not acceptable to release
until it is fixed, the release cannot proceed. Instead, work with the
DistributedLog community to resolve the issue.
+
+### Review Release Notes in JIRA
+
+JIRA automatically generates Release Notes based on the `Fix Version`
field applied to issues. Release Notes are intended for DistributedLog users
(not DistributedLog committers/contributors). You should ensure that Release
Notes are informative and useful.
+
+Open the release notes from the [version status
page](https://issues.apache.org/jira/browse/DL/?selectedTab=com.atlassian.jira.jira-projects-plugin:versions-panel)
by choosing the release underway and clicking Release Notes.
+
+You should verify that the issues listed automatically by JIRA are
appropriate to appear in the Release Notes. Specifically, issues should:
+
+* Be appropriately classified as `Bug`, `New Feature`, `Improvement`, etc.
+* Represent noteworthy user-facing changes, such as new functionality,
backward-incompatible API changes, or performance improvements.
+* Have occurred since the previous release; an issue that was introduced
and fixed between releases should not appear in the Release Notes.
+* Have an issue title that makes sense when read on its own.
+
+Adjust any of the above properties to the improve clarity and presentation
of the Release Notes.
+
+### Create a release branch
+
+Release candidates are built from a release branch. As a final step in
preparation for the release, you should create the release branch, push it to
the code repository, and update version information on the original branch.
+
+Check out the version of the codebase from which you start the release.
For a new minor or major release, this may be `HEAD` of the `master` branch. To
build a hotfix/incremental release, instead of the `master` branch, use the
release tag of the release being patched. (Please make sure your cloned
repository is up-to-date before starting.)
+
+ git checkout <master branch OR release tag>
+
+
+Set up a few environment variables to simplify Maven commands that follow.
(We use `bash` Unix syntax in this guide.)
+
+ VERSION="0.4.0-incubating"
+ NEXT_VERSION="0.5.0-incubating"
+ BRANCH_NAME="release-${VERSION}"
+ DEVELOPMENT_VERSION="${NEXT_VERSION}-SNAPSHOT"
+
+Version represents the release currently underway, while next version
specifies the anticipated next version to be released from that branch.
Normally, 0.4.0 is followed by 0.5.0, while 0.4.0 is followed by 0.4.1.
+
+Use Maven release plugin to create the release branch and update the
current branch to use the new development version. This command applies for the
new major or minor version. (Warning: this command automatically pushes changes
to the code repository.)
+
+ mvn release:branch \
+ -DbranchName=${BRANCH_NAME} \
+ -DdevelopmentVersion=${DEVELOPMENT_VERSION}
+
+However, if you are doing an incremental/hotfix release, please run the
following command after checking out the release tag of the release being
patched.
+
+ mvn release:branch \
+ -DbranchName=${BRANCH_NAME} \
+ -DupdateWorkingCopyVersions=false \
+ -DupdateBranchVersions=true \
+ -DreleaseVersion="${VERSION}-SNAPSHOT"
+
+Check out the release branch.
+
+ git checkout ${BRANCH_NAME}
+
+The rest of this guide assumes that commands are run in the root of a
repository on `${BRANCH_NAME}` with the above environment variables set.
+
+### Checklist to proceed to the next step
+
+1. Release Managerâs GPG key is published to `dist.apache.org`
+1. Release Managerâs GPG key is configured in `git` configuration
+1. Release Manager has `org.apache.distributedlog` listed under `Staging
Profiles` in Nexus
+1. Release Managerâs Nexus User Token is configured in `settings.xml`
+1. JIRA release item for the subsequent release has been created
+1. There are no release blocking JIRA issues
+1. Release Notes in JIRA have been audited and adjusted
+1. Release branch has been created
+1. Originating branch has the version information updated to the new
version
+
+**********
+
+## Build a release candidate
+
+The core of the release process is the build-vote-fix cycle. Each cycle
produces one release candidate. The Release Manager repeats this cycle until
the community approves one release candidate, which is then finalized.
+
+### Build and stage Java artifacts with Maven
+
+Set up a few environment variables to simplify Maven commands that follow.
This identifies the release candidate being built. Start with `RC_NUM` equal to
`1` and increment it for each candidate.
+
+ RC_NUM="1"
+ TAG="v${VERSION}-RC${RC_NUM}"
+
+Use Maven release plugin to build the release artifacts, as follows:
+
+ mvn release:prepare \
+ -Dresume=false \
+ -DreleaseVersion=${VERSION} \
+ -Dtag=${TAG} \
+ -DupdateWorkingCopyVersions=false
+
+Use Maven release plugin to stage these artifacts on the Apache Nexus
repository, as follows:
+
+ mvn release:perform
+
+Review all staged artifacts. They should contain all relevant parts for
each module, including `pom.xml`, jar, test jar, source, test source, javadoc,
etc. Artifact names should follow [the existing
format](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.distributedlog%22)
in which artifact name mirrors directory structure, e.g.,
`distributedlog-core`. Carefully review any new artifacts.
+
+Close the staging repository on Apache Nexus. When prompted for a
description, enter âApache DistributedLog, version X, release candidate Yâ.
+
+### Stage source release on dist.apache.org
+
+Copy the source release to the dev repository of `dist.apache.org`.
+
+1. If you have not already, check out the DistributedLog section of the
`dev` repository on `dist.apache.org` via Subversion. In a fresh directory:
+
+ svn co
https://dist.apache.org/repos/dist/dev/incubator/distributedlog
+
+1. Make a directory for the new release:
+
+ mkdir distributedlog/${VERSION}
+
+1. Copy and rename the DistributedLog source distribution, hashes, and GPG
signature:
+
+ cp
${DL_ROOT}/target/distributedlog-parent-${VERSION}-source-release.zip
distributedlog/${VERSION}/apache-distributedlog-${VERSION}-source-release.zip
+ cp
${DL_ROOT}/target/distributedlog-parent-${VERSION}-source-release.zip.asc
distributedlog/${VERSION}/apache-distributedlog-${VERSION}-source-release.zip.asc
+ cp
${DL_ROOT}/target/distributedlog-parent-${VERSION}-source-release.zip.md5
distributedlog/${VERSION}/apache-distributedlog-${VERSION}-source-release.zip.md5
+ cp
${DL_ROOT}/target/distributedlog-parent-${VERSION}-source-release.zip.sha1
distributedlog/${VERSION}/apache-distributedlog-${VERSION}-source-release.zip.sha1
+
+1. Add and commit all the files.
+
+ svn add distributedlog/${VERSION}
+ svn commit
+
+1. Verify that files are
[present](https://dist.apache.org/repos/dist/dev/incubator/distributedlog).
+
+### Build the API reference
+
+DistributedLog publishes API reference manual for each release on the
website. For Java SDK, thatâs Javadoc.
+
+Check out release candidate, as follows:
+
+ git checkout ${TAG}
+
+Use Maven Javadoc plugin to generate the new Java reference manual, as
follows:
+
+ mvn -DskipTests clean package javadoc:aggregate \
+ -Ddoctitle="Apache DistributedLog Library for Java, version
${VERSION}" \
+ -Dwindowtitle="Apache DistributedLog Library for Java, version
${VERSION}" \
+ -Dmaven.javadoc.failOnError=false
+
+By default, the Javadoc will be generated in `target/site/apidocs/`. Let
`${JAVADOC_ROOT}` be the absolute path to `apidocs`. ([Pull request
#1015](https://github.com/apache/incubator-distributedlog/pull/1015) will
hopefully simplify this process.)
+
+Please carefully review the generated Javadoc. Check for completeness and
presence of all relevant packages and `package-info.java`; consider adding less
relevant packages to the `excludePackageNames` configuration. The index page is
generated at `${JAVADOC_ROOT}/index.html`.
+
+### Propose a pull request for website updates
+
+The final step of building the candidate is to propose a website pull
request.
+
+Add the new release to the [Apache DistributedLog Releases]({{
site.baseurl }}/use/releases/) page, as follows:
+
+* Update the `<version>` tags in the sample `pom.xml` snippet to the new
release.
+* Add the new version to the `Release Notes` section below, along with
links to the source code download and the Release Notes in JIRA.
+
+Add the new Javadoc to [API Reference page]({{ site.baseurl
}}/user_guide/api/core) page, as follows:
+
+* Copy the generated Javadoc into the website repository: `cp -r
${JAVADOC_ROOT} user_guid/api/core/javadoc/${VERSION}`.
+* Update the Javadoc link on this page to point to the new version.
+
+Finally, propose a pull request with these changes. (Donât merge before
finalizing the release.)
+
+### Checklist to proceed to the next step
+
+1. Maven artifacts deployed to the staging repository of
[repository.apache.org](https://repository.apache.org/content/repositories/)
+1. Source distribution deployed to the dev repository of
[dist.apache.org](https://dist.apache.org/repos/dist/dev/incubator/distributedlog/)
+1. Website pull request proposed to list the [release]({{ site.baseurl
}}/use/releases/) and publish the [API reference manual]({{ site.baseurl
}}/user/api/core/javadoc/)
+
+**********
+
+## Vote on the release candidate
+
+Once you have built and individually reviewed the release candidate,
please share it for the community-wide review. Please review foundation-wide
[voting guidelines](http://www.apache.org/foundation/voting.html) for more
information.
+
+Start the review-and-vote thread on the dev@ mailing list. Hereâs an
email template; please adjust as you see fit.
+
+ From: Release Manager
+ To: [email protected]
+ Subject: [VOTE] Release 0.4.0, release candidate #0
+
+ Hi everyone,
+ Please review and vote on the release candidate #0 for the version
0.4.0, as follows:
+ [ ] +1, Approve the release
+ [ ] -1, Do not approve the release (please provide specific comments)
+
+
+ The complete staging area is available for your review, which includes:
+ * JIRA release notes [1],
+ * the official Apache source release to be deployed to dist.apache.org
[2],
+ * all artifacts to be deployed to the Maven Central Repository [3],
+ * source code tag "v0.4.0-RC0" [4],
+ * website pull request listing the release and publishing the API
reference manual [5].
+
+ The vote will be open for at least 72 hours. It is adopted by majority
approval, with at least 3 PPMC affirmative votes.
+
+ Thanks,
+ Release Manager
+
+ [1] link
+ [2] link
+ [3] link
+ [4] link
+ [5] link
+
+If there are any issues found in the release candidate, reply on the vote
thread to cancel the vote. Thereâs no need to wait 72 hours. Proceed to the
`Fix Issues` step below and address the problem. However, some issues donât
require cancellation. For example, if an issue is found in the website pull
request, just correct it on the spot and the vote can continue as-is.
+
+If there are no issues, reply on the vote thread to close the voting.
Then, tally the votes in a separate email. Hereâs an email template; please
adjust as you see fit.
+
+ From: Release Manager
+ To: [email protected]
+ Subject: [RESULT] [VOTE] Release 0.4.0, release candidate #0
+
+ I'm happy to announce that we have unanimously approved this release.
+
+ There are XXX approving votes, XXX of which are binding:
+ * approver 1
+ * approver 2
+ * approver 3
+ * approver 4
+
+ There are no disapproving votes.
+
+ Thanks everyone!
+
+While in incubation, the Apache Incubator PMC must also vote on each
release, using the same process as above. Start the review and vote thread on
the `[email protected]` list.
+
+ From: Release Manager
+ To: [email protected]
+ Cc: [email protected]
+ Subject: [VOTE] Apache DistributedLog release 0.4.0-incubating
+
+ Hi everyone,
+ Please review and vote on the release candidate #0 for the Apache
DistributedLog version 0.4.0-incubating, as follows:
+ [ ] +1, Approve the release
+ [ ] -1, Do not approve the release (please provide specific comments)
+
+
+ The complete staging area is available for your review, which includes:
+ * JIRA release notes [1],
+ * the official Apache source release to be deployed to dist.apache.org
[2],
+ * all artifacts to be deployed to the Maven Central Repository [3],
+ * source code tag "v0.4.0-RC0" [4],
+ * website pull request listing the release and publishing the API
reference manual [5].
+
+ The Apache DistributedLog community has unanimously approved this
release [6].
+
+ As customary, the vote will be open for at least 72 hours. It is
adopted by
+ a majority approval with at least three PMC affirmative votes. If
approved,
+ we will proceed with the release.
+
+ Thanks!
+
+ [1] link
+ [2] link
+ [3] link
+ [4] link
+ [5] link
+ [6] lists.apache.org permalink to the vote result thread, e.g., link
+
+If passed, close the voting and summarize the results.
+
+ From: Release Manager
+ To: [email protected]
+ Cc: [email protected]
+ Subject: [RESULT] [VOTE] Apache DistributedLog release 0.4.0-incubating
+
+ There are XXX approving votes, all of which are binding:
+ * approver 1
+ * approver 2
+ * approver 3
+ * approver 4
+
+ There are no disapproving votes.
+
+ We'll proceed with this release as staged.
+
+ Thanks everyone!
+
+### Checklist to proceed to the finalization step
+
+1. Community votes to release the proposed candidate
--- End diff --
done
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
