You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openjpa.apache.org by mi...@apache.org on 2012/11/14 04:46:46 UTC
svn commit: r1409076 - /openjpa/site/trunk/content/release-setup.mdtext
Author: mikedd
Date: Wed Nov 14 03:46:46 2012
New Revision: 1409076
URL: http://svn.apache.org/viewvc?rev=1409076&view=rev
Log:
Fix some issues with release-setup page. < and > still need to be escaped (at least) and there are plenty of other formatting changes to make
Modified:
openjpa/site/trunk/content/release-setup.mdtext
Modified: openjpa/site/trunk/content/release-setup.mdtext
URL: http://svn.apache.org/viewvc/openjpa/site/trunk/content/release-setup.mdtext?rev=1409076&r1=1409075&r2=1409076&view=diff
==============================================================================
--- openjpa/site/trunk/content/release-setup.mdtext (original)
+++ openjpa/site/trunk/content/release-setup.mdtext Wed Nov 14 03:46:46 2012
@@ -1,9 +1,6 @@
Title: Release Setup
These setup steps only need to be performed on a particular machine once.
-{info}Developers using Linux workstations can skip over the references to
-Cygwin. If using Windows, install cygwin, including *Utils/gnupg* and
-*Net/openssh* packages.
-{info}
+Developers using Linux workstations can skip over the references to Cygwin. If using Windows, install cygwin, including __Utils/gnupg__ and __Net/openssh__ packages.
<a name="ReleaseSetup-CreateandinstallaSSHkey"></a>
### Create and install a SSH key
@@ -11,88 +8,66 @@ Cygwin. If using Windows, install cygwi
1. Open a shell window. If using Windows, open a cygwin window.
1. Use ssh-keygen to create an SSH key.
{note}
-* ssh-keygen dsa key type only accept 1024 bits; use rsa / 4096 bits
-instead.{note}
-{code:none}
-$ ssh-keygen -t rsa -b 4096
-
- Program defaults should be fine. No passphrase is required for the ssh key
-generation. The keys will be saved in ~/.ssh/id_rsa (private) and
-~/.ssh/id_rsa.pub (public).
- {info} See [Authenticating By Public Key (OpenSSH)|http://www.networknewz.com/networknewz-10-20030707AuthenticatingbyPublicKeyOpenSSH.html]
- for a good description on why and how to perform this task.
- {info}
- # {{scp}} your SSH public key ~/.ssh/id_rsa.pub created in last step to
-~/id_rsa.pub on people.apache.org.
- {code:none}
+ * ssh-keygen dsa key type only accept 1024 bits; use rsa / 4096 bits instead.
+ $ ssh-keygen -t rsa -b 4096
+
+ Program defaults should be fine. No passphrase is required for the ssh key generation. The keys will be saved in ~/.ssh/id_rsa (private) and ~/.ssh/id_rsa.pub (public).
+
+ See [Authenticating By Public Key(OpenSSH)](http://www.networknewz.com/networknewz-10-20030707AuthenticatingbyPublicKeyOpenSSH.html) for a good description on why and how to perform this task.
+
+1. scp your SSH public key ~/.ssh/id_rsa.pub created in last step to ~/id_rsa.pub on people.apache.org.
+
$ cd ~/.ssh
$ scp id_rsa.pub <your userid>@people.apache.org:id_rsa.pub
- $ You will be prompted for your password.
+
+ You will be prompted for your password.
1. Use ssh to login to people.apache.org
-{code:none}
-$ cd ~
-$ ssh <your userid>@people.apache.org
+
+ $ cd ~
+ $ ssh <your userid>@people.apache.org
At this point, you will still be prompted for your password.
- # Create a ~/.ssh folder in your home directory on people.apache.org and
-change its file mode to 700.
- {code:none}
+1. Create a ~/.ssh folder in your home directory on people.apache.org and change its file mode to 700.
+
$ mkdir ~/.ssh
$ chmod 700 ~/.ssh
-1. Move or append ~/id_rsa.pub to ~/.ssh/authorized_keys and change its file
-mode to 600.
-{code:none}
-$ mv ~/id_rsa.pub ~/.ssh/authorized_keys
+1. Move or append ~/id_rsa.pub to ~/.ssh/authorized_keys and change its file mode to 600.
+
+ $ mv ~/id_rsa.pub ~/.ssh/authorized_keys
or
-$ cat ~/id_rsa.pub >> ~/.ssh/authorized_keys
-$ chmod 600 ~/.ssh/authorized_keys
+ $ cat ~/id_rsa.pub >> ~/.ssh/authorized_keys
+ $ chmod 600 ~/.ssh/authorized_keys
- {info}
* Each public key in the {{authorized_keys}} spans only one line.
- ** For example: "{{ssh-dss AAAAB3NzaC1kc3MAAA ..... agBmmfZ9uAbSqA==
-dsa-key-20071107}}"
+ * For example:
+ "{{ssh-dss AAAAB3NzaC1kc3MAAA ..... agBmmfZ9uAbSqA== dsa-key-20071107}}"
* '#' in the first column is a comment line.
- {info}
- # Exit out of this ssh session.
- # Start a new ssh session. No login should be required this time due to
-the private ssh key on your local box matching up with the public ssh key
-in your home directory (~/.ssh).
- {code:none}
+1. Exit out of this ssh session.
+1. Start a new ssh session. No login should be required this time due to the private ssh key on your local box matching up with the public ssh key in your home directory (~/.ssh).
$ ssh <your userid>@people.apache.org
-{info}
-If you are still prompted for a password, then you have not set up the ssh
-keys properly. Review the steps above and ensure that all of the steps
-were followed properly. Or, maybe the instructions are still not quite
-right and they still need some adjusting. In that case, please update the
-instructions accordingly. :-)
-{info}
+If you are still prompted for a password, then you have not set up the ssh keys properly. Review the steps above and ensure that all of the steps were followed properly. Or, maybe the instructions are still not quite right and they still need some adjusting. In that case, please update the instructions accordingly. :-)
<a name="ReleaseSetup-CreateaGPGkey"></a>
### Create a GPG key
1. Open a shell window. If using Windows, open a cygwin window.
-{info}
* The generated keys are stored in:
-** *nix - $HOME/.gnupg
-** Windows XP - %HOME%\Application Data\gnupg
-** Windows 7 - C:\ProgramData\GNU\etc\gnupg
+ * *nix - $HOME/.gnupg
+ * Windows XP - %HOME%\Application Data\gnupg
+ * Windows 7 - C:\ProgramData\GNU\etc\gnupg
* "gpg --version" shows the GnuPG's home location.
-* Follow the latest steps and guides on the ASF website at [http://www.apache.org/dev/openpgp.html#generate-key](http://www.apache.org/dev/openpgp.html#generate-key)
- as you need to disable using SHA1 and new keys should be 4096 bits. Append
-the following text to gpg.conf.
-{code:none}
-personal-digest-preferences SHA512
-cert-digest-algo SHA512
-default-preference-list SHA512 SHA384 SHA256 SHA224 AES256 AES192 AES CAST5
-ZLIB BZIP2 ZIP Uncompressed
-
- ** If you are using an existing gpg certificate, update your current
-certificate with the above preference using:
- {code:none}
+* Follow the latest steps and guides on the ASF website at [http://www.apache.org/dev/openpgp.html#generate-key](http://www.apache.org/dev/openpgp.html#generate-key) as you need to disable using SHA1 and new keys should be 4096 bits.
+* Append the following text to gpg.conf.
+ personal-digest-preferences SHA512
+ cert-digest-algo SHA512
+ default-preference-list SHA512 SHA384 SHA256 SHA224 AES256 AES192 AES CAST5
+ ZLIB BZIP2 ZIP Uncompressed
+
+ * If you are using an existing gpg certificate, update your current certificate with the above preference using:
leealber@jpadev:~/.gnupg$ gpg --edit-key Albert Lee
Secret key is available.
@@ -127,56 +102,37 @@ BZIP2 ZIP Uncompressed
[ultimate]
(1). Albert Lee (CODE SIGNING KEY) <al...@apache.org>
- Command>{code}
- {info}
- # Generate a key-pair with gpg, using default key kind ("DSA and Elgamal")
-and ELG-E keys size (2048).
- {code:none}
+ Command>
+1 Generate a key-pair with gpg, using default key kind ("DSA and Elgamal") and ELG-E keys size (2048).
$ gpg --gen-key
-The program's default values should be fine. For the "Real Name" enter
-your full name (ie. Stan Programmer). For the "e-mail address" enter your
-apache address (ie. sprogrammer@apache.org). You will also be required to
-enter a "passphrase" for the GPG key generation. Keep track of this as you
-will need this for the Release processing.
-{info}
-* Save the content in this subdirectory to a safe media. This contains your
-private key used to sign all the release materials.
-{info}
+ The program's default values should be fine. For the "Real Name" enter your full name (ie. Stan Programmer). For the "e-mail address" enter your apache address (ie. sprogrammer@apache.org). You will also be required to enter a "passphrase" for the GPG key generation. Keep track of this as you will need this for the Release processing.
+* Save the content in this subdirectory to a safe media. This contains your private key used to sign all the release materials.
1. Backup your cygwin home directory to another media
1. Append your public key to {{[https://svn.apache.org/repos/asf/openjpa/KEYS](https://svn.apache.org/repos/asf/openjpa/KEYS)
-}} and *http://www.apache.org/dist/openjpa/KEYS*. See the commands
-describe at the beginning of this KEYS file to perform this task. The gpg
-key-pair is used to sign the published artifacts for the releases.
-{code:none}
-$ ( gpg --list-sigs <Real Name> && gpg --armor --export <Real Name> ) >>
-KEYS
-
- {info}
- * The {{[https://svn.apache.org/repos/asf/openjpa/KEYS]
-}} file is updated via normal svn commit procedures.
-
-svn co https://svn.apache.org/repos/asf/openjpa --depth empty
-cd openjpa
-svn up KEYS
-( gpg --list-sigs <Real Name> && gpg --armor --export <Real Name> ) >> KEYS
-svn commit KEYS --message "update gpg public key for ME."
-
- * The one under www.apache.org/dist/ has to be manually updated.
-
-scp KEYS yourid@people.apache.org:/www/www.apache.org/dist/openjpa/KEYS
-
- {info}
- # Submit your public key to a key server. E.g. [http://pgp.surfnet.nl:11371/]
- or [http://pgp.mit.edu/]
- # Following the instructions in [http://people.apache.org/~henkp/trust/]
- and ask multiple (at least 3) current Apache committers to sign your
-public key.
+}} and __http://www.apache.org/dist/openjpa/KEYS__. See the commands describe at the beginning of this KEYS file to perform this task. The gpg key-pair is used to sign the published artifacts for the releases.
+ $ ( gpg --list-sigs <Real Name> && gpg --armor --export <Real Name> ) >>
+ KEYS
+
+* The {{[https://svn.apache.org/repos/asf/openjpa/KEYS] }} file is updated via normal svn commit procedures.
+
+ svn co https://svn.apache.org/repos/asf/openjpa --depth empty
+ cd openjpa
+ svn up KEYS
+ ( gpg --list-sigs <Real Name> && gpg --armor --export <Real Name> ) >> KEYS
+ svn commit KEYS --message "update gpg public key for ME."
+
+* The one under www.apache.org/dist/ has to be manually updated.
+
+1. scp KEYS yourid@people.apache.org:/www/www.apache.org/dist/openjpa/KEYS
+
+1. Submit your public key to a key server. E.g. [http://pgp.surfnet.nl:11371/] or [http://pgp.mit.edu/]
+ * Following the instructions in [http://people.apache.org/~henkp/trust/] and ask multiple (at least 3) current Apache committers to sign your public key.
- h3. Update Maven settings for our servers
+### Update Maven settings for our servers
- # Create a settings.xml under .m2
- | | {code:xml|title=settings.xml|borderStyle=solid}
+1. Create a settings.xml under .m2
+
<settings xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
@@ -228,17 +184,8 @@ http://maven.apache.org/xsd/settings-1.0
</profiles>
</settings>
-{info}
-* *$USERNAME* is the remote username on people.apache.org, not your local
-userid.
-* *$PATH_TO_PRIVATE_KEY* is the path to the private key generated for
-ssh. E.g. /home/yourLocalUserId/.ssh/id_rsa. For Windows' cygwin users,
-you will need to enter the full cygwin path:
-/cygdrive/c/cygwin/home/yourLocalUserId/.ssh/id_rsa.
-* *$SSH_PASSPHRASE* for the supplied *$PATH_TO_PRIVATE_KEY*. If you
-don't use this in your settings.xml file, then you will be prompted for it
-during the Release processing.
-* *$GPG_PASSPHRASE* is pass phase for the GPG key.
-* *$APACHE_LDAP_PWD* is your Apache LDAP password, which is shared
-between SVN and password login for people.apache.org.
-{info}
+* *$USERNAME* is the remote username on people.apache.org, not your local userid.
+* __$PATH_TO_PRIVATE_KEY__ is the path to the private key generated for ssh. E.g. /home/yourLocalUserId/.ssh/id_rsa. For Windows' cygwin users, you will need to enter the full cygwin path: /cygdrive/c/cygwin/home/yourLocalUserId/.ssh/id_rsa.
+* __$SSH_PASSPHRASE__ for the supplied __$PATH_TO_PRIVATE_KEY__. If you don't use this in your settings.xml file, then you will be prompted for it during the Release processing.
+* __$GPG_PASSPHRASE__ is pass phase for the GPG key.
+* __$APACHE_LDAP_PWD__ is your Apache LDAP password, which is shared between SVN and password login for people.apache.org.