This is an automated email from the ASF dual-hosted git repository.
philo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-gluten.git
The following commit(s) were added to refs/heads/main by this push:
new edb5cdc645 [GLUTEN-10874][INFRA] Maturity RE50: In documentation, add
a section for the release process (#10883)
edb5cdc645 is described below
commit edb5cdc645e4e914cc6ba59c405dd38937e2d4da
Author: Hongze Zhang <[email protected]>
AuthorDate: Tue Oct 21 03:11:43 2025 +0100
[GLUTEN-10874][INFRA] Maturity RE50: In documentation, add a section for
the release process (#10883)
---
dev/release/package-release.sh | 7 +-
docs/developers/HowToRelease.md | 334 ++++++++++++++++++++++++++++++++++++++++
2 files changed, 340 insertions(+), 1 deletion(-)
diff --git a/dev/release/package-release.sh b/dev/release/package-release.sh
index ec18101ae2..18a170aa7d 100755
--- a/dev/release/package-release.sh
+++ b/dev/release/package-release.sh
@@ -36,6 +36,7 @@ GLUTEN_HOME=${CURRENT_DIR}/../../
if [ ! -d "$GLUTEN_HOME/release/" ]; then
echo "Release directory does not exist."
fi
+
pushd $GLUTEN_HOME/release/
SPARK_VERSIONS="3.2 3.3 3.4 3.5"
@@ -53,13 +54,17 @@ for v in $SPARK_VERSIONS; do
done
SRC_ZIP="${TAG}.zip"
-SRC_DIR="incubator-gluten-${TAG_VERSION}"
+SRC_DIR="incubator-gluten-${RELEASE_VERSION}"
echo "Packaging source code..."
wget https://github.com/apache/incubator-gluten/archive/refs/tags/${SRC_ZIP}
unzip -q ${SRC_ZIP}
+
+# Rename folder to remove "rc*" for formal release.
+mv incubator-gluten-${TAG_VERSION} ${SRC_DIR}
tar -czf apache-gluten-${RELEASE_VERSION}-incubating-src.tar.gz ${SRC_DIR}
rm -r ${SRC_ZIP} ${SRC_DIR}
popd
+
echo "Finished packaging release binaries and source code."
diff --git a/docs/developers/HowToRelease.md b/docs/developers/HowToRelease.md
new file mode 100644
index 0000000000..30cf932231
--- /dev/null
+++ b/docs/developers/HowToRelease.md
@@ -0,0 +1,334 @@
+---
+layout: page
+title: How to Release
+nav_order: 17
+parent: Developer Overview
+---
+
+# Create Release Source and Binaries
+
+The document provides a standard process for creating the sources and binaries
that are required
+for a release of Apache Gluten project with the Velox backend.
+
+## Prerequisites
+
+1. x86-64
+2. Linux
+3. Docker
+
+## Steps to Create a Release
+
+A standard release distribution can be created following the below steps.
+
+### Pull and run the dev docker image
+
+Pull and download the build environment docker image. The docker image is
periodically
+built and uploaded to DockerHub by scheduled GitHub Actions jobs.
+
+```bash
+docker pull apache/gluten:vcpkg-centos-7
+docker run -it apache/gluten:vcpkg-centos-7 bash
+```
+
+### Clone the repository
+
+In the docker container created by the last step, execute the following
command to
+clone the repository of Gluten with a specific git tag that you want to build
on.
+
+We are taking `v1.6.0-example-rc3` as an example git tag in this guide.
+
+```bash
+git clone --branch v1.6.0-example-rc3
https://github.com/apache/incubator-gluten.git /workspace
+```
+
+### Build
+
+Build the project for all supported Spark versions.
+
+```bash
+cd /workspace
+bash dev/release/build-release.sh
+```
+
+### Copy the target binaries to release directory
+
+```bash
+cd /workspace
+mkdir -p release
+copy -R package/target/* release/
+```
+
+### Package the release sources and binaries
+
+By following this step you will create the release distribution that comply
with the common name
+convention of ASF project release process.
+
+Note, the current tag should be specified when running this script.
+
+```bash
+cd /workspace
+bash dev/release/package-release.sh v1.6.0-example-rc3
+```
+
+### Check the created release distribution
+
+Confirm that all the needed sources and binaries are successfully created at
the release directory
+`$GLUTEN_HOME/release/`.
+
+```bash
+[root@8de83f716f0f workspace]# ls -l release/
+total 481628
+-rw-r--r--. 1 root root 74396439 Oct 14 14:19
apache-gluten-1.6.0-example-incubating-src.tar.gz
+-rw-r--r--. 1 root root 104790092 Oct 14 14:19
apache-gluten-1.6.0-example-incubating-bin-spark-3.2.tar.gz
+-rw-r--r--. 1 root root 104767582 Oct 14 14:19
apache-gluten-1.6.0-example-incubating-bin-spark-3.3.tar.gz
+-rw-r--r--. 1 root root 104625356 Oct 14 14:19
apache-gluten-1.6.0-example-incubating-bin-spark-3.4.tar.gz
+-rw-r--r--. 1 root root 104595103 Oct 14 14:19
apache-gluten-1.6.0-example-incubating-bin-spark-3.5.tar.gz
+```
+
+<!--- Moved from
https://github.com/apache/incubator-gluten-site/blob/main/_docs/v1.3.0/developers/HowToRelease.md
--->
+# Publish the Release
+
+This section outlines the steps for releasing Apache Gluten (incubating)
according to the Apache release guidelines.
+All projects under the Apache umbrella must adhere to the [Apache Release
Policy](https://www.apache.org/legal/release-policy.html). This guide is
designed to assist you in comprehending the policy and navigating the process
of releasing projects at Apache.
+
+## Release Process
+
+1. Prepare the release artifacts.
+
+2. Upload the release artifacts to the SVN repository.
+
+3. Verify the release artifacts.
+
+4. Initiate a release vote.
+
+5. Announce the results and the release.
+
+
+### Prepare the release artifacts.
+
+1. Create a branch from the target git repository.
+
+2. Tag a RC and draft the release notes.
+
+3. Build and Sign the release artifacts (including source archives, binaries,
...etc).
+
+4. Generate checksums for the artifacts.
+
+
+#### How to Sign the release artifacts.
+
+1. Create a GPG key
+
+2. Add the GPG key to the KEYS file
+
+3. Sign the release artifacts with the GPG key.
+
+```bash
+# create a GPG key, after executing this command, select the first one RSA 和
RSA
+$ gpg --full-generate-key
+
+# list the GPG keys
+$ gpg --keyid-format SHORT --list-keys
+
+# upload the GPG key to the key server, xxx is the GPG key id
+# eg: pub rsa4096/4C21E346 2024-05-06 [SC], 4C21E346 is the GPG key id;
+$ gpg --keyserver keyserver.ubuntu.com --send-key xxx
+
+# append the GPG key to the KEYS file the svn repository
+# [IMPORTANT] Don't replace the KEYS file, just append the GPG key to the KEYS
file.
+$ svn co https://dist.apache.org/repos/dist/release/incubator/gluten/
+$ (gpg --list-sigs [email protected] && gpg --export --armor [email protected]) >>
KEYS
+$ svn ci -m "add gpg key"
+
+# sign the release artifacts, xxxx is [email protected]
+$ for i in *.tar.gz; do echo $i; gpg --local-user xxxx --armor --output $i.asc
--detach-sig $i ; done
+```
+
+
+#### How to Generate checksums for the release artifacts.
+
+```bash
+# create the checksums
+$ for i in *.tar.gz; do echo $i; sha512sum $i > $i.sha512 ; done
+```
+
+
+### Upload the release artifacts to the SVN repository.
+
+1. Create a project directory in the SVN repository (1st time only).
+ `https://dist.apache.org/repos/dist/dev/incubator/gluten/`
+
+2. Create a directory for the release artifacts in the SVN repository.
+ `https://dist.apache.org/repos/dist/dev/incubator/gluten/{release-version}`
+ release-version format: apache-gluten-#.#.#-rc#
+
+3. Upload the release artifacts to the SVN repository.
+```bash
+$ svn co https://dist.apache.org/repos/dist/dev/incubator/gluten/
+$ cp /path/to/release/artifacts/* ./{release-version}/
+$ svn add ./{release-version}/*
+$ svn commit -m "add Apache Gluten release artifacts for {release-version}"
+```
+
+4. After the upload, please visit the link
`https://dist.apache.org/repos/dist/dev/incubator/gluten/{release-version}` to
verify if the file upload is successful or not.
+ The upload release artifacts should be include
+```bash
+* apache-gluten-#.#.#-incubating-src.tar.gz
+* apache-gluten-#.#.#-incubating-src.tar.gz.asc
+* apache-gluten-#.#.#-incubating-src.tar.gz.sha512
+```
+
+
+### Verify the release artifacts.
+
+Please follow below steps to verify the release artifacts.
+
+1. Check if the Download links are valid.
+
+2. Check if the checksums and GPG signatures are valid.
+
+3. Check if the release artifacts name is qualified and match with the current
release.
+
+4. Check if LICENSE and NOTICE files are correct.
+
+5. Check if the License Headers are included in all files if necessary.
+
+6. No unlicensed compiled archives bundled in source archive.
+
+
+#### How to Verify the Signatures
+
+Please follow below steps to verify the signatures.
+
+```bash
+# download KEYS
+$ curl https://dist.apache.org/repos/dist/release/incubator/gluten/KEYS > KEYS
+
+# import KEYS and trust the key, please replace the email address with the one
you want to trust.
+$ gpg --import KEYS
+$ gpg --edit-key [email protected]
+gpg> trust
+gpg> 5
+gpg> y
+gpg> quit
+
+# enter the directory where the release artifacts are located
+$ cd /path/to/release/artifacts
+
+# verify the signature
+$ for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i ; done
+
+# if you see 'Good signature' in the output, it means the signature is valid.
+```
+
+
+#### How to Verify the checksums
+
+Please follow below steps to verify the checksums
+```bash
+# verify the checksums
+$ for i in *.tar.gz; do echo $i; sha512sum --check $i.sha512; done
+```
+
+
+### Initiate a release vote.
+
+1. Email a vote request to [email protected], requiring at least 3 PPMC
+1s.
+
+2. Allow 72 hours or until enough votes are collected.
+
+3. Share the vote outcome on the dev list.
+
+4. If successful, request a vote on [email protected], needing 3
PMC +1s.
+
+5. Wait 72 hours or for sufficient votes.
+
+6. Announce the results on the general list.
+
+Vote Email Template
+```
+[VOTE] Release Apache Gluten (Incubating) {release-version}
+
+Hello,
+
+ This is a call for vote to release Apache Gluten (Incubating) version
{release-version}.
+
+ The vote thread:
+ https://lists.apache.org/thread/{id}
+
+ Vote Result:
+ https://lists.apache.org/thread/{id}
+
+ The release candidates:
+
https://dist.apache.org/repos/dist/dev/incubator/gluten/{release-version}/
+
+ Release notes:
+
https://github.com/apache/incubator-gluten/releases/tag/{release-version}
+
+ Git tag for the release:
+
https://github.com/apache/incubator-gluten/releases/tag/{release-version}
+
+ Git commit id for the release:
+ https://github.com/apache/incubator-gluten/commit/{id}
+
+ Keys to verify the Release Candidate:
+ https://downloads.apache.org/incubator/gluten/KEYS
+
+ The vote will be open for at least 72 hours or until the necessary number
of votes are reached.
+
+ Please vote accordingly:
+
+ [ ] +1 approve
+ [ ] +0 no opinion
+ [ ] -1 disapprove with the reason
+
+ Checklist for reference:
+
+ [ ] Download links are valid.
+ [ ] Checksums and PGP signatures are valid.
+ [ ] Source code distributions have correct names matching the current
release.
+ [ ] LICENSE and NOTICE files are correct for each Apache Gluten repo.
+ [ ] All files have license headers if necessary.
+ [ ] No unlicensed compiled archives bundled in source archive.
+
+ To compile from the source, please refer to:
+
+ https://github.com/apache/incubator-gluten#building-from-source
+
+Thanks,
+<YOUR NAME>
+```
+
+### Announce the results and the release.
+
+
+Announce Email Template
+```
+Hello everyone,
+
+The Apache Gluten (Incubating) {release-version} has been released!
+
+Apache Gluten is a Q&A platform software for teams at any scale.
+Whether it's a community forum, help center, or knowledge management platform,
you can always count on Apache Gluten.
+
+Download Links: https://downloads.apache.org/incubator/gluten/
+
+Release Notes:
https://github.com/apache/incubator-gluten/releases/tag/{release-version}
+
+Website: https://gluten.apache.org/
+
+Resources:
+- Issue: https://github.com/apache/incubator-gluten/issues
+- Mailing list: [email protected]
+
+Thanks,
+<YOUR NAME>
+
+```
+
+### Migrate candidate to the release Apache SVN
+
+After the vote has passed, you need to migrate the RC build release to an
official release by moving the artifacts from Apache SVN's dev directory to the
release directory. Please follow the steps below to upload the artifacts:
+```
+$ svn mv
https://dist.apache.org/repos/dist/dev/incubator/gluten/{release-version}
https://dist.apache.org/repos/dist/release/incubator/gluten/{release-version}
-m "transfer packages for gluten {release-version}"
+```
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
