You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sedona.apache.org by ji...@apache.org on 2022/11/16 19:23:45 UTC
[incubator-sedona] branch master updated: [DOCS] Further automate the release script (#715)
This is an automated email from the ASF dual-hosted git repository.
jiayu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-sedona.git
The following commit(s) were added to refs/heads/master by this push:
new b13412e9 [DOCS] Further automate the release script (#715)
b13412e9 is described below
commit b13412e96ac20de87cb7803fa664acaf0930d1c0
Author: Jia Yu <ji...@apache.org>
AuthorDate: Wed Nov 16 12:23:40 2022 -0700
[DOCS] Further automate the release script (#715)
---
docs/community/publish.md | 9 ++++++---
docs/community/release-manager.md | 34 +++++++++++++++++++++++++++-------
docs/community/snapshot.md | 3 +++
pom.xml | 2 +-
4 files changed, 37 insertions(+), 11 deletions(-)
diff --git a/docs/community/publish.md b/docs/community/publish.md
index 2d68ee78..c444c5e8 100644
--- a/docs/community/publish.md
+++ b/docs/community/publish.md
@@ -15,8 +15,9 @@ echo "#!/bin/bash" > create-release.sh
chmod 777 create-release.sh
```
2. Use your favourite GUI text editor to open `create-release.sh`.
-3. Then keep copying the scripts on this web page to replace all content in this text file.
+3. Then keep copying the scripts on this web page to replace all content in this script file.
4. Do NOT directly copy/paste the scripts to your terminal because a bug in `clipboard.js` will create link breaks in such case.
+5. Each time when you copy content to this script file, run `./create-release.sh` to execute it.
## 1. Check ASF copyright in all file headers
@@ -60,6 +61,8 @@ Make sure the Sedona version in the following files are {{ sedona_create_release
```bash
#!/bin/bash
+source ~/.bashrc
+
git checkout master
git pull
@@ -350,8 +353,8 @@ Apache Sedona (incubating) Team
If a vote failed, do the following:
-1. Drop the staging repo on `repository.apache.org`.
-2. Restart from Step 3 `Update mkdocs.yml`. Please use `{{ sedona_create_release.current_version}}-rc2` to update `sedona_create_release.current_rc` and `sedona_create_release.current_git_tag` in `mkdocs.yml` to generate the script listed on this webpage.
+1. In the vote email, say that we will create another release candidate.
+2. Restart from Step 3 `Update mkdocs.yml`. Please increment the release candidate ID (e.g., `{{ sedona_create_release.current_version}}-rc2`) and update `sedona_create_release.current_rc` and `sedona_create_release.current_git_tag` in `mkdocs.yml` to generate the script listed on this webpage.
## 8. Release source code and Maven package
diff --git a/docs/community/release-manager.md b/docs/community/release-manager.md
index 2f778da0..1a997eec 100644
--- a/docs/community/release-manager.md
+++ b/docs/community/release-manager.md
@@ -28,18 +28,39 @@ You only need to perform these steps if this is your first time being a release
* At the prompt, enter the length of time the key should be valid: Press `enter` to make the key never expire.
* Verify that your selections are correct.
* Enter your user ID information: use your real name and Apache email address.
- * Type a secure passphrase. Make sure you remember this!
+ * Type a secure passphrase. Make sure you remember this because we will use it later.
* Use the `gpg --list-secret-keys --keyid-format=long` command to list the long form of the GPG keys.
* From the list of GPG keys, copy the long form of the GPG key ID you'd like to use (e.g., `3AA5C34371567BD2`)
* Run `gpg --export --armor 3AA5C34371567BD2`, substituting in the GPG key ID you'd like to use.
* Copy your GPG key, beginning with `-----BEGIN PGP PUBLIC KEY BLOCK-----` and ending with `-----END PGP PUBLIC KEY BLOCK-----`.
* There must be an empty line between `-----BEGIN PGP PUBLIC KEY BLOCK-----` and the actual key.
3. Publish your armored key in major key servers: https://keyserver.pgp.com/
-4. Use SVN to append your armored PGP public key to the `KEYS` files. You can ask Jia to help you with this step.
+
+### 3. Use SVN to update KEYS
+
+Use SVN to append your armored PGP public key to the `KEYS` files
* https://dist.apache.org/repos/dist/dev/incubator/sedona/KEYS
* https://dist.apache.org/repos/dist/release/incubator/sedona/KEYS
-### 3. Add GPG_TTY environment variable
+1. Check out both KEYS files
+```bash
+svn checkout https://dist.apache.org/repos/dist/dev/incubator/sedona/ sedona-dev --depth files
+svn checkout https://dist.apache.org/repos/dist/release/incubator/sedona/ sedona-release --depth files
+```
+2. Use your favorite text editor to open `sedona-dev/KEYS` and `sedona-release/KEYS`.
+3. Paste your armored key to the end of both files. Note: There must be an empty line between `-----BEGIN PGP PUBLIC KEY BLOCK-----` and the actual key.
+4. Commit both KEYS. SVN might ask you to enter your ASF ID and password. Make sure you do it so SVN can always store your ID and password locally.
+```bash
+svn commit -m "Update KEYS" sedona-dev/KEYS
+svn commit -m "Update KEYS" sedona-release/KEYS
+```
+5. Then remove both svn folders
+```bash
+rm -rf sedona-dev
+rm -rf sedona-release
+```
+
+### 4. Add GPG_TTY environment variable
In your `~/.bashrc` file, add the following content. Then restart your terminal.
@@ -48,7 +69,7 @@ GPG_TTY=$(tty)
export GPG_TTY
```
-### 4. Get GitHub personal access token (classic)
+### 5. Get GitHub personal access token (classic)
You need to create a GitHub personal access token (classic). You can follow the instruction on [GitHub](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#creating-a-personal-access-token-classic).
@@ -61,11 +82,11 @@ In short:
5. Give your token a descriptive name.
6. To give your token an expiration, select the Expiration drop-down menu. Make sure you set the `Expiration` to `No expiration`.
7. Select the scopes you'd like to grant this token. To use your token to access repositories from the command line, select `repo` and `admin:org`.
-8. Click Generate token.
+8. Click `Generate token`.
9. Please save your token somewhere because we will use it in the next step.
-### 5. Set up credentials for Maven
+### 6. Set up credentials for Maven
In your `~/.m2/settings.xml` file, add the following content. Please create this file or `.m2` folder if it does not exist.
@@ -94,7 +115,6 @@ Please replace all capitalized text with your own ID and password.
<profile>
<id>gpg</id>
<properties>
- <gpg.executable>gpg2</gpg.executable>
<gpg.passphrase>YOUR_GPG_PASSPHRASE</gpg.passphrase>
</properties>
</profile>
diff --git a/docs/community/snapshot.md b/docs/community/snapshot.md
index 2b3fbe57..5610c121 100644
--- a/docs/community/snapshot.md
+++ b/docs/community/snapshot.md
@@ -19,6 +19,7 @@ chmod 777 create-release.sh
2. Use your favourite GUI text editor to open `create-release.sh`.
3. Then keep copying the scripts on this web page to replace all content in this text file.
4. Do NOT directly copy/paste the scripts to your terminal because a bug in `clipboard.js` will create link breaks in such case.
+5. Each time when you copy content to this script file, run `./create-release.sh` to execute it.
## 1. Upload snapshot versions
@@ -27,6 +28,8 @@ In your Sedona GitHub repo, run this script:
```bash
#!/bin/bash
+source ~/.bashrc
+
git checkout master
git pull
diff --git a/pom.xml b/pom.xml
index 5d272bb2..fb98ba83 100644
--- a/pom.xml
+++ b/pom.xml
@@ -322,7 +322,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
- <version>1.5</version>
+ <version>3.0.1</version>
<executions>
<execution>
<id>sign-artifacts</id>