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 887c43a Add the publish Sedona step
887c43a is described below
commit 887c43a488c995e2f4a9d827c432c81612e28d0d
Author: Jia Yu <[email protected]>
AuthorDate: Tue Dec 29 23:27:42 2020 -0800
Add the publish Sedona step
---
docs/download/compile.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 63 insertions(+), 1 deletion(-)
diff --git a/docs/download/compile.md b/docs/download/compile.md
index a7cd7e0..ace53da 100644
--- a/docs/download/compile.md
+++ b/docs/download/compile.md
@@ -182,4 +182,66 @@ mvn deploy -DskipTests -Dscala=2.12 -Dspark=2.4
### Publish Python project to PyPi
-## Publish releases
\ No newline at end of file
+## Publish releases
+
+### Stage the releases
+
+#### For Spark 3.0 and Scala 2.12
+
+1. Convert source code to Spark 3 format
+```bash
+python3 spark-version-converter.py spark3
+```
+2. Prepare a release. Manually enter the following variables in the terminal:
release id: ==1.0.0-incubator==, scm tag id:
==sedona-3.0_2.12-1.0.0-incubator== (this is just an example. Please use the
correct version number). You also need to provide GitHub username and password
+```bash
+mvn clean release:prepare -DautoVersionSubmodules=true -Dresume=false
-Darguments="-DskipTests"
+```
+3. Stage a release
+```bash
+mvn clean release:perform -DautoVersionSubmodules=true -Dresume=false
-Darguments="-DskipTests"
+```
+4. Now the releases are staged. A tag and two commits will be created on
Sedona GitHub repo.
+
+Now let's repeat the process to other Sedona modules.
+
+#### For Spark 2.4 and Scala 2.11
+
+1. Convert source code to Spark 2 format
+```bash
+python3 spark-version-converter.py spark2
+```
+2. Manuallly commit the changes of the three scala files to GitHub
+3. Prepare a release. Note that: release id: ==1.0.0-incubator==, scm tag id:
==sedona-2.4_2.11-1.0.0-incubator== (this is just an example. Please use the
correct version number)
+```bash
+mvn clean release:prepare -DautoVersionSubmodules=true -Dresume=false
-DcheckModificationExcludeList=sql/src/main/scala/org/apache/sedona/sql/UDF/UdfRegistrator.scala,sql/src/main/scala/org/apache/spark/sql/sedona_sql/strategy/join/JoinQueryDetector.scala,sql/src/main/scala/org/apache/spark/sql/sedona_sql/strategy/join/TraitJoinQueryExec.scala
-Darguments="-DskipTests -Dscala=2.11 -Dspark=2.4"
+```
+4. Stage a release
+```bash
+mvn clean release:perform -DautoVersionSubmodules=true -Dresume=false
-Darguments="-DskipTests -Dscala=2.11 -Dspark=2.4"
+```
+
+#### For Spark 2.4 and Scala 2.12
+
+Step 1 and 2 are only needed if you didn't run the previous step before
+
+1. Convert source code to Spark 2 format
+```bash
+python3 spark-version-converter.py spark2
+```
+2. ==Manuallly commit the changes of the three scala files to GitHub==
+3. Prepare a release: release id: ==1.0.0-incubator==, scm tag id:
==sedona-2.4_2.12-1.0.0-incubator== (this is just an example. Please use the
correct version number)
+```bash
+mvn clean release:prepare -DautoVersionSubmodules=true -Dresume=false
-DcheckModificationExcludeList=sql/src/main/scala/org/apache/sedona/sql/UDF/UdfRegistrator.scala,sql/src/main/scala/org/apache/spark/sql/sedona_sql/strategy/join/JoinQueryDetector.scala,sql/src/main/scala/org/apache/spark/sql/sedona_sql/strategy/join/TraitJoinQueryExec.scala
-Darguments="-DskipTests -Dscala=2.12 -Dspark=2.4"
+```
+4. Stage a release
+```bash
+mvn clean release:perform -DautoVersionSubmodules=true -Dresume=false
-Darguments="-DskipTests -Dscala=2.12 -Dspark=2.4"
+```
+
+!!!warning
+ After staged the three releases, you need to manually revert the
commited three scala files. You will see 6 [maven-release-plugin] commits and 3
more tags in Sedona GitHub repo.
+
+### Close the staging repo
+1. Check the status of the staging repo: [Locate and Examine Your Staging
Repository
+](https://central.sonatype.org/pages/releasing-the-deployment.html#locate-and-examine-your-staging-repository).
You should see 12 Sedona modules in total.
+2. Call for a vote in Sedona community and Apache incubator. Then close the
staging repo.
\ No newline at end of file
