distributedlog-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From franckcuny <...@git.apache.org>
Subject [GitHub] incubator-distributedlog pull request #51: (WIP) DL-81: Build the distribute...
Date Tue, 13 Dec 2016 17:33:29 GMT
Github user franckcuny commented on a diff in the pull request:

    https://github.com/apache/incubator-distributedlog/pull/51#discussion_r92221776
  
    --- 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 <anonymous@apache.org>
    +    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`
    --- End diff --
    
    bullet or increment


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message