sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1505705 - in /sis/site/trunk: ./ content/release/ content/release/setup.mdtext
Date Mon, 22 Jul 2013 15:00:12 GMT
Author: desruisseaux
Date: Mon Jul 22 15:00:11 2013
New Revision: 1505705

URL: http://svn.apache.org/r1505705
Log:
First attempt to provide part of release management instructions as CMS pages.

Added:
    sis/site/trunk/content/release/
    sis/site/trunk/content/release/setup.mdtext
      - copied, changed from r1505670, sis/branches/JDK7/src/site/apt/release-setup.apt
Modified:
    sis/site/trunk/   (props changed)

Propchange: sis/site/trunk/
------------------------------------------------------------------------------
--- svn:ignore (added)
+++ svn:ignore Mon Jul 22 15:00:11 2013
@@ -0,0 +1 @@
+nbproject

Copied: sis/site/trunk/content/release/setup.mdtext (from r1505670, sis/branches/JDK7/src/site/apt/release-setup.apt)
URL: http://svn.apache.org/viewvc/sis/site/trunk/content/release/setup.mdtext?p2=sis/site/trunk/content/release/setup.mdtext&p1=sis/branches/JDK7/src/site/apt/release-setup.apt&r1=1505670&r2=1505705&rev=1505705&view=diff
==============================================================================
--- sis/branches/JDK7/src/site/apt/release-setup.apt [UTF-8] (original)
+++ sis/site/trunk/content/release/setup.mdtext [UTF-8] Mon Jul 22 15:00:11 2013
@@ -1,188 +1,175 @@
-~~
-~~ 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.
-~~
-
-                            ---------------------------------
-                            One time release management setup
-                            ---------------------------------
+Title:  Apache SIS
+Notice: 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.
 
-One time release management setup
 
-  The following instructions need to be done only once by new release managers,
-  or when configuring a new machine for performing the releases.
-  If those steps have already been done, jump directly to the {{{./release-process.html}Release
process}} page.
+One time release management setup
+=================================
 
-%{toc|fromDepth=2|toDepth=3}
+The following instructions need to be done only once by new release managers,
+or when configuring a new machine for performing the releases.
+If those steps have already been done, jump directly to the [Release process](release-process.html)
page.
 
 
-* Directory layout (including Subversion checkout)
 
-  The steps described in the <Release process> page assumes the following directory
layout.
-  Some directories are SVN checkout, other are ordinary directories. Any other layout can
be used.
-  However in the later case, all relative paths in the {{{./release-process.html}Release
process}}
-  page will need to be adjusted accordingly.
+Directory layout (including Subversion checkout)
+------------------------------------------------
 
-+---------------------------+
-<any root directory for SIS>
-├─ trunk
-├─ branches
-├─ tags
-└─ distribution
-+---------------------------+
+The steps described in the release process page assume the following directory layout.
+Some directories are SVN checkout, other are ordinary directories. Any other layout can be
used.
+However in the later case, all relative paths in the release process page will need to be
adjusted accordingly.
 
-  Create the above directory structure as below:
+    :::text
+    <any root directory for SIS>
+    ├─ trunk
+    ├─ branches
+    ├─ tags
+    └─ distribution
 
---------------------------------------------------------------------
-svn checkout https://svn.apache.org/repos/asf/sis/trunk
-svn checkout https://dist.apache.org/repos/dist/dev/sis distribution
-mkdir branches
-mkdir tags
---------------------------------------------------------------------
+Create the above directory structure as below:
 
+    :::bash
+    svn checkout https://svn.apache.org/repos/asf/sis/trunk
+    svn checkout https://dist.apache.org/repos/dist/dev/sis distribution
+    mkdir branches
+    mkdir tags
 
 
-* Shell configuration
 
-  It is better for Unix shells to contain the following line in their initialization file
-  (typically <<<\~/.bashrc>>> or <<<\~/.profile>>>, where
<<<\~>>> stands for the user's home directory):
+Shell configuration
+-------------------
 
----------------------
-export GPG_TTY=$(tty)
----------------------
+It is better for Unix shells to contain the following line in their initialization file
+(typically `~/.bashrc` or `~/.profile`, where `~` stands for the user's home directory):
 
+    :::bash
+    export GPG_TTY=$(tty)
 
-* Generate GPG key
 
-  The releases have to be signed by public key cryptography signatures.
-  Detailed instructions about why releases have to be signed are provided on the {{{http://www.apache.org/dev/release-signing.html}Release
Signing}} page.
-  The standard used is OpenPGP (<Open Pretty Good Privacy>), and a popular software
implementation of that standard is GPG (<GNU Privacy Guard>).
-  The {{{http://www.apache.org/dev/openpgp.html}OpenPGP instructions}} list out detailed
steps on managing your keys.
-  The following steps provide a summary:
 
-  Edit the <<<\~/.gnupg/gpg.conf>>> configuration file (where <<<\~>>>
is the home directory) and add the following
-  configuration options, or edit the existing values if any:
+Generate GPG key
+----------------
 
--------------------------------------------------------------------------------------------------------
-personal-digest-preferences SHA512
-cert-digest-algo SHA512
-default-preference-list SHA512 SHA384 SHA256 SHA224 AES256 AES192 AES CAST5 ZLIB BZIP2 ZIP
Uncompressed
--------------------------------------------------------------------------------------------------------
+The releases have to be signed by public key cryptography signatures.
+Detailed instructions about why releases have to be signed are provided on the [Release Signing][signing]
page.
+The standard used is OpenPGP (_Open Pretty Good Privacy_), and a popular software implementation
of that standard is GPG (_GNU Privacy Guard_).
+The {{{http://www.apache.org/dev/openpgp.html}OpenPGP instructions}} list out detailed steps
on managing your keys.
+The following steps provide a summary:
 
-  Generate 4096 bits RSA key pair using the following command-line. GPG will prompts for
various informations.
-  The list below the command suggests some values, keeping in mind that the new key should
be used only for
-  signing Apache softwares - not for daily emails.
+Edit the `~/.gnupg/gpg.conf` configuration file and add the following configuration options,
+or edit the existing values if any:
 
--------------
-gpg --gen-key
--------------
+    :::text
+    personal-digest-preferences SHA512
+    cert-digest-algo SHA512
+    default-preference-list SHA512 SHA384 SHA256 SHA224 AES256 AES192 AES CAST5 ZLIB BZIP2
ZIP Uncompressed
 
-   * Kind of key: RSA and RSA (default). Do not create DSA key.
+Generate 4096 bits RSA key pair using the following command-line. GPG will prompts for various
informations.
+The list below the command suggests some values, keeping in mind that the new key should
be used only for
+signing Apache softwares - not for daily emails.
 
-   * Key size: 4096 bits.
+    :::bash
+    gpg --gen-key
 
-   * Validity time: 0 (key does not expire).
+ * Kind of key: RSA and RSA (default). Do not create DSA key.
+ * Key size: 4096 bits.
+ * Validity time: 0 (key does not expire).
+ * Real name: the developer's name.
+ * Email address: developer's email address at <<<@apache.org>>>.
+ * Comment: "CODE SIGNING KEY".
+ * Passphrase: please choose a strong one.
 
-   * Real name: the developer's name.
+Verify the key information (replace _Real Name_ by the above-cited developer's name, keeping
quotes in the command below).
+Note the key identifier, which is a value like `EB98E066`. This key identifier will be needed
for the next steps.
 
-   * Email address: developer's email address at <<<@apache.org>>>.
+    :::bash
+    gpg --list-sigs "Real Name"
 
-   * Comment: "CODE SIGNING KEY".
+Sends the public key to a keys server (replace `<key_id>` by the above-cited key identifier).
+The default GPG configuration sends the key to `hkp://keys.gnupg.net`.
+Note that while there is many key servers, most of them synchronize changes with each other,
+so a key uploaded to one should be disseminated to the rest.
 
-   * Passphrase: please choose a strong one.
+    :::bash
+    gpg --send-key <key_id>
 
-  Verify the key information (replace <Real Name> by the above-cited developer's name,
keeping quotes in the command below).
-  Note the key identifier, which is a value like <<<EB98E066>>>. This key
identifier will be needed for the next steps.
+Generate a revocation certificate. This is not for immediate use, but generating the certificate
now
+is a safety in case the passphrase is lost. Keep the revocation certificate in a safe place.
 
----------------------------
-gpg --list-sigs "Real Name"
----------------------------
 
-  Sends the public key to a keys server (replace <<<<key_id>>>> by
the above-cited key identifier).
-  The default GPG configuration sends the key to <<<hkp://keys.gnupg.net>>>.
-  Note that while there is many key servers, most of them synchronize changes with each other,
-  so a key uploaded to one should be disseminated to the rest.
+   :::bash
+   gpg --output revocation_certificate.asc --gen-revoke <key_id>
 
------------------------
-gpg --send-key <key_id>
------------------------
+Have the key signed by at least three Apache commiters. This can be done by executing the
following commands on
+the machine of the other Apache commiter, where `<key_to_use>` is the identifier of
the other commiter's key.
+Those operation should preferably be done in some event where the commiters can meet face-to-face.
+The other commiter should verify that the `gpg --fingerprint` command output matches the
fingerprint of the key to sign.
 
-  Generate a revocation certificate. This is not for immediate use, but generating the certificate
now
-  is a safety in case the passphrase is lost. Keep the revocation certificate in a safe place.
+    :::bash
+    gpg --recv-keys <key_id>
+    gpg --fingerprint <key_id>
+    gpg --default-key <key_to_use> --sign-key <key_id>
+    gpg --send-key <key_id>
 
--------------------------------------------------------------
-gpg --output revocation_certificate.asc --gen-revoke <key_id>
--------------------------------------------------------------
+The above-cited _Release Signing_ page provides more instructions.
+Then, the signed public key shall be appended to the `KEYS` file on [SIS distribution directory][dist].
 
-  Have the key signed by at least three Apache commiters. This can be done by executing the
following commands on
-  the machine of the other Apache commiter, where <<<<key_to_use>>>>
is the identifier of the other commiter's key.
-  Those operation should preferably be done in some event where the commiters can meet face-to-face.
-  The other commiter should verify that the <<<gpg --fingerprint>>> command
output matches the fingerprint of the key to sign.
 
---------------------------------------------------
-gpg --recv-keys <key_id>
-gpg --fingerprint <key_id>
-gpg --default-key <key_to_use> --sign-key <key_id>
-gpg --send-key <key_id>
---------------------------------------------------
 
-  The above-cited <Release Signing> page provides more instructions.
-  Then, the signed public key shall be appended to the <<<KEYS>>> file
on
-  {{http://dist.apache.org/repos/dist/release/sis/}}.
+Maven Configuration & Nexus Setup
+---------------------------------
 
+Detailed instructions are at [Publishing Maven Artifacts][maven].
+In summary, the developer needs to specify username, and optionally password, in his local
`~/.m2` directory.
+If not already done, create a Maven master password:
 
-* Maven Configuration & Nexus Setup
+    :::bash
+    mvn --encrypt-master-password <password>
 
-  Detailed instructions are at {{{http://www.apache.org/dev/publishing-maven-artifacts.html}Publishing
Maven Artifacts}}.
-  In summary, the developer needs to specify username, and optionally password, in his local
<<<\~/.m2>>> directory.
-  If not already done, create a Maven master password:
+The command will produce an encrypted version of the given password, something like `\{jSMOWnoPFgsHVpMvz5VrIt5kRbzGpI8u+9EF1iFQyJQ=\}`.
+Store this password in the `~/.m2/settings-security.xml` file like below:
 
-----------------------------------------
-mvn --encrypt-master-password <password>
-----------------------------------------
+    :::xml
+    <settingsSecurity>
+      <master>{jSMOWnoPFgsHVpMvz5VrIt5kRbzGpI8u+9EF1iFQyJQ=}</master>
+    </settingsSecurity>
 
-  The command will produce an encrypted version of the given password, something like <<<\{jSMOWnoPFgsHVpMvz5VrIt5kRbzGpI8u+9EF1iFQyJQ=\}>>>.
-  Store this password in the <<<\~/.m2/settings-security.xml>>> file like
below:
+Then encrypt the passphrase of the GPG key created in above steps, like below:
 
-+---------------------------------------------------------------+
-<settingsSecurity>
-  <master>{jSMOWnoPFgsHVpMvz5VrIt5kRbzGpI8u+9EF1iFQyJQ=}</master>
-</settingsSecurity>
-+---------------------------------------------------------------+
+    :::bash
+    mvn --encrypt-password <passphrase>
 
-  Then encrypt the passphrase of the GPG key created in above steps, like below:
+The command will produce an encrypted version of the passphrase, something like `\{COQLCE6DU6GtcS5P=\}`.
+Cut-and-paste it in a section of the `~/.m2/settings.xml` file like below:
 
------------------------------------
-mvn --encrypt-password <passphrase>
------------------------------------
+    :::xml
+    <settings>
+    ...
+      <servers>
+        <server>
+          <id>apache.releases.https</id>
+          <username> <!-- YOUR APACHE USERNAME --> </username>
+          <password>{COQLCE6DU6GtcS5P=}</password>
+        </server>
+       ...
+      </servers>
+    </settings>
 
-  The command will produce an encrypted version of the passphrase, something like <<<\{COQLCE6DU6GtcS5P=\}>>>.
-  Cut-and-paste it in a section of the <<<\~/.m2/settings.xml>>> file like
below:
 
-+--------------------------------------------------------------------+
-<settings>
-...
-  <servers>
-    <server>
-      <id>apache.releases.https</id>
-      <username> <!-- YOUR APACHE USERNAME --> </username>
-      <password>{COQLCE6DU6GtcS5P=}</password>
-    </server>
-   ...
-  </servers>
-</settings>
-+--------------------------------------------------------------------+
+[signing]: http://www.apache.org/dev/release-signing.html
+[dist]:    http://dist.apache.org/repos/dist/release/sis/
+[maven]:   http://www.apache.org/dev/publishing-maven-artifacts.html



Mime
View raw message