[GitHub] [drill] vvysotskyi commented on a change in pull request #1937: DRILL-7230: Add README.md with instructions for release and release scripts

[GitBox <gi...@apache.org>]

vvysotskyi commented on a change in pull request #1937: DRILL-7230: Add README.md with instructions for release and release scripts
URL: https://github.com/apache/drill/pull/1937#discussion_r360362502
 
 

 ##########
 File path: docs/dev/Release.md
 ##########
 @@ -0,0 +1,365 @@
+# Drill Release Process
+
+1. ## Setup release final cut-off date
+
+    1. Start mail thread on Apache dev list with the subject: 
+        ```
+       [DISCUSS] Drill 1.17.0 release
+        ```
+
+        Body example:
+        ```
+        Hi Drillers,
+         
+        It's been several months since the last release and it is time to do the next one. I am volunteering to be the release manager.
+         
+        If there are any issues on which work is in progress, that you feel we *must* include in the release, please post in reply to this thread. Based on your input we'll define release cut off date.
+         
+        Kind regards
+         
+        Thanks
+        ```
+    2. Gather list of Jiras that need to be included in the release, discuss possible blockers.
+    3. Identify final cut-off date.
+    4. Before starting the release send a reminder to dev list that merge in Apache Drill master is forbidden during
+     release.
+    
+        Example:
+        ```
+        Note for the committers:
+        until the release is not over and Drill version is not changed to 1.17.0-SNAPSHOT, please do not push any
+        changes into Drill master.
+        ```
+         
+2. ## Setup environment:
+    1. ### GPG key:
+        You will need a GPG key set up. This key is needed for signing the release.
+        1. Read [Apache docs for release signing](http://www.apache.org/dev/release-signing.html).
+        2. Install the `gpg2` package on Ubuntu, or `gnupg` on MacOS.
+        3. Generate GPG key using the **Apache email address** if it wasn't done before:
+            1. Run `gpg --gen-key` and follow the instructions.
+            2. Remember your passphrase.
+            3. Save your key pair:
+                ```
+               gpg --output mygpgkey_pub.gpg --armor --export MY_KEY_ID
+               gpg --output mygpgkey_sec.gpg --armor --export-secret-key MY_KEY_ID
+               ```
+        4. Or import existing GPG key pair if required:
+            ```
+            gpg --import mygpgkey_pub.gpg
+            gpg --allow-secret-key-import --import mygpgkey_sec.gpg
+            ```
+        5. Have another committer signed your key (add to the trust chain).
+            Apache advises to do it at 
+            [key signing parties](https://www.apache.org/dev/release-signing.html#key-signing-party).
+        6. Make sure default key is the key generated using the Apache email.
+        7. Publish your public key to a public server (e.g. http://pgp.surfnet.nl or http://pgp.mit.edu)
+            using Web-UIs or CLI (for example using the following command:
+            `gpg --keyserver hkp://pool.sks-keyservers.net --trust-model always --send-keys`)
+        8. Add your key signature to the `KEYS` file in the Drill sources repo.
+            Instruction on how to create the key signature is embedded at the beginning of the KEYS file.
+        9. Add your key signature to the `KEYS` file in `https://dist.apache.org` (PMC permissions required for this):
+            - `svn co https://dist.apache.org/repos/dist/release/drill ~/src/release/drill-dist`
+            - Update `KEYS` file with required changes
+            - Commit changes: `svn ci -m "Add FirstName LastName's key to KEYS file"`
+    2. ### Setting up LDAP credentials
+        1. Go to http://id.apache.org and log in using your Apache login and password.
+        2. Scroll to the bottom to the 'SSH Key' entry and add the SSH key from your `~/.ssh/id_rsa.pub` file.
+            If you don't have the SSH key, you should generate it by running `ssh-keygen`.
+        3. Note that you can add more than 1 SSH key corresponding to multiple machines.
+        4. Enter your Apache password and submit changes.
+        5. Verify that you can do an sftp to the apache server by running the following: `sftp <username>@home.apache.org`
+
+    3. ### SVN
+        You also need access to Apache SVN. (You need to be a PMC member for this).
+    4. ### Setup Maven
+        1. Apache's Maven repository access is documented here:
+            http://www.apache.org/dev/publishing-maven-artifacts.html
+            http://www.apache.org/dev/publishing-maven-artifacts.html#dev-env.
+        2. For deploying maven artifacts, you must add entries to your `~/.m2/settings.xml` file as described here:
+            http://www.apache.org/dev/publishing-maven-artifacts.html#dev-env.
+        3. In order to encrypt the LDAP password, see here:
+            http://maven.apache.org/guides/mini/guide-encryption.html.
+            The encrypted master password should be added to `~/.m2/security-settings.xml`.
+        4. Add encrypted password to `settings.xml` and `security-settings.xml`:
+            1. run `mvn --encrypt-master-password` and encrypted master password to `security-settings.xml` file;
+            2. run `mvn --encrypt-password` and encrypted Apache LDAP password to `settings.xml` file.
+    5. Check that `NOTICE` file in sources has the current copyright year.
+    6. Make sure you are using JDK 8 (not 9 or 13).
 
 Review comment:
   Thanks, done.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services