This is an automated email from the ASF dual-hosted git repository.
davidzollo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/seatunnel-website.git
The following commit(s) were added to refs/heads/main by this push:
new c3a44cf827e8 [Docs] Document ATR release distribution workflow (#562)
c3a44cf827e8 is described below
commit c3a44cf827e8d722e58ca0f7e234ac7b5adb520a
Author: zhiweiniu <[email protected]>
AuthorDate: Wed Nov 18 23:08:43 2026 +0800
[Docs] Document ATR release distribution workflow (#562)
---
community/contribution_guide/release.md | 144 +++++++++++++++++++++++++++++---
1 file changed, 134 insertions(+), 10 deletions(-)
diff --git a/community/contribution_guide/release.md
b/community/contribution_guide/release.md
index b90a944e4e10..20aa9b45797c 100644
--- a/community/contribution_guide/release.md
+++ b/community/contribution_guide/release.md
@@ -15,6 +15,20 @@ For a release, you go through the following steps:
The source code and build process must comply with the ASF legal and
intellectual property requirements for a valid release, and the project must
have the infrastructure in place to correctly sign the release artifacts.
+## Choose a distribution workflow
+
+Complete [Environment Preparation](#environment-preparation) and [Project
version preparation](#project-version-preparation)
+for either workflow. Maven/Nexus publication and Git version/tag preparation
use the existing commands below.
+Use the same release version, tag and commit for Maven artifacts and
distribution archives.
+
+- **SVN:** Prepare the SVN repositories, then follow [SVN distribution
workflow](#svn-distribution-workflow),
+ [Vote by mail](#vote-by-mail) and [Moving files](#moving-files).
+- **ATR:** Follow [ATR distribution workflow](#atr-distribution-workflow)
after Maven staging.
+ Use the ATR website for candidate uploads, voting and publication, or upload
files with rsync.
+
+`${RELEASE.VERSION}` is a documentation placeholder. Replace it and the
example usernames/key IDs with
+the actual values before running commands.
+
## Environment Preparation
If this is the first time for a publisher to publish, you need to install the
necessary environment, including the signature tool GnuPG and Maven repository
certification-related preparations.
@@ -24,7 +38,7 @@ Use to clone project source code locally.
### Install GPG
Used to generate a digital signature, leaving a trail of every action you
take. Apache's maven and SVN repositories both use GPG signatures to verify the
validity of files.
-Download GnuPG binary releases from [the official GnuPG
website](https://www.gnupg.org/download/index.html).
+Download GnuPG binary releases from [the official GnuPG
website](https://www.gnupg.org/download/index.html).
Note: The commands of 1. x and 2. x versions of GnuPG are slightly different.
The following description takes 2.2.28 as an example. After the installation,
the GPG command is added to the system environment variable and is available.
```bash
@@ -150,6 +164,9 @@ It is normal that the key generated in the previous step is
inconsistent with th
Used to generate signatures for files.
### SVN
+
+This setup is required only for the SVN workflow. ATR setup is covered in
[Prepare ATR](#prepare-atr).
+
Used to pull the Apache Release SVN repository. Apache uses svn to host the
release of the project.
#### Pull the release and dev repositories to the local
@@ -205,7 +222,7 @@ Add the file `${user.home}/.m2/settings-security.xml` to
configure the password
mvn --encrypt-password <apache password>
```
##### Add new profile
-Edit the configuration file of your local maven environment, the general path
is `~/.m2/setting.xml`, and add the following xml file:
+Edit the configuration file of your local maven environment, the general path
is `~/.m2/settings.xml`, and add the following xml file:
```xml
<settings>
@@ -232,6 +249,8 @@ Edit the configuration file of your local maven
environment, the general path is
## Project version preparation
+These Git and Maven/Nexus preparation steps apply to both SVN and ATR.
+
### Branch preparation
```bash
mkdir -p ~/seatunnel-release-prepare
@@ -256,14 +275,11 @@ mvn release:prepare -Prelease -Darguments="-DskipTests
-Dskip.spotless=true" -Dd
before this step, you need edit the `.gitignore` file, delete
`seatunnel-examples` first.
```bash
mvn release:clean
-mvn release:prepare -Prelease -Darguments="-DskipTests -Dskip.spotless=true"
-DpushChanges=false -Dusername=${GITHUB USERNAME}
-```
-After this step, the code has changed, and it not match our project's code
style requirement, so you need run this command to fix code style and commit
change.
-```bash
-./mvnw spotless:apply
-git commit -am "fix code style"
+mvn release:prepare -Prelease -DpreparationGoals="clean spotless:apply
spotless:check package" -DcompletionGoals="spotless:apply spotless:check"
-Darguments="-DskipTests -Dskip.spotless=false" -DpushChanges=false
-Dusername="${GITHUB_USERNAME}"
```
+This command formats and checks the POMs automatically, so no separate
formatting commit is needed.
+
### Submit source code
```bash
@@ -292,13 +308,108 @@ git push
```bash
mvn release:perform -Prelease -Darguments="-DskipTests -Dskip.spotless=true"
-Dusername=${GITHUB USERNAME}
```
-> ** Note: During the execution of this command, ensure that the IP address
remains constant; otherwise, multiple unusable repositories might appear in
stagingRepositories.**
+> **Note: During the execution of this command, ensure that the IP address
remains constant; otherwise, multiple unusable repositories might appear in
stagingRepositories.**
- Close the stage repository
[https://repository.apache.org/#stagingRepositories](https://repository.apache.org/#stagingRepositories)

-## Upload to SVN
+## ATR distribution workflow
+
+### Prepare ATR
+
+1. If you do not have release permissions in ATR, ask a PMC member to
designate you as a
+ [Release Manager](https://releases.apache.org/docs/release-manager-setup).
+2. Before your first release or after changing signing keys, register your GPG
public key on the
+ [ATR keys page](https://releases.apache.org/keys). If it is missing from
the committee's
+ [`KEYS`
file](https://releases.apache.org/docs/moving-to-atr#the-keys-file), ask a PMC
member to add it before publishing.
+3. Sign in to [ATR](https://releases.apache.org/) and create a `seatunnel`
version matching the POM's release
+ version. It must be **Composing** before uploading.
+
+### Sign the ATR candidate
+
+Copy the archives and any existing `.asc`/`.sha512` files from
`seatunnel-dist/target` into a clean directory.
+If needed, generate signatures and checksums there:
+
+```bash
+# For terminal-based GPG passphrase prompts, select the current terminal.
+export GPG_TTY="$(tty)"
+for archive in *.tar.gz; do
+ gpg --armor --detach-sign "$archive" || exit 1
+ shasum -a 512 "$archive" > "$archive.sha512" || exit 1
+done
+```
+
+Enter your **GPG Signing Key Passphrase** when prompted.
+
+### Upload the ATR candidate
+
+#### Upload through the website
+
+Open `https://releases.apache.org/compose/seatunnel/${RELEASE.VERSION}` and
use **Upload files** to upload
+the archives with their `.asc` and `.sha512` files.
+> **Note: For GitHub projects, enter the full 40-character SHA of the release
branch's last commit used to build the archives in the Source commit hash
field.**
+
+#### Upload with rsync
+
+Register your **SSH public key** on the [ATR keys
page](https://releases.apache.org/keys) and configure SSH
+to use it. Set `YOUR_FILES` to a directory containing only the candidate
archives, signatures and checksums;
+`ASF_USERNAME` is your ASF username.
+
+```bash
+# ATR SSH listens on port 2222 and authenticates with the registered SSH key.
+rsync -av -e 'ssh -p 2222' "${YOUR_FILES}/"
"${ASF_USERNAME}@releases.apache.org:/seatunnel/${RELEASE.VERSION}/"
+```
+
+#### Retry an interrupted or failed upload
+
+On the **Composing** page, remove failed or incomplete uploads and resend the
existing files through the
+website or rsync. Unchanged files need no rebuild or signing.
+
+### Validate the ATR candidate
+
+Confirm the file list and automated check results in ATR.
+
+Download from the [ATR download
page](https://releases.apache.org/download/all/seatunnel), checking that the
+version and revision match the vote. Extract the ZIP or use the page's
download commands in a new empty directory.
+
+Import the signing key if it is absent from your local GPG keyring:
+
+```bash
+curl -fsS https://downloads.apache.org/seatunnel/KEYS -o KEYS
+gpg --import KEYS
+```
+
+Check the full signing-key fingerprint against the release manager and
committee `KEYS`, then verify
+the downloaded archives from that directory:
+
+```bash
+for archive in *.tar.gz; do
+ gpg --verify "$archive.asc" "$archive" || exit 1
+ shasum -a 512 -c "$archive.sha512" || exit 1
+done
+```
+
+Inspect archive contents and `LICENSE`/`NOTICE`, and complete functional and
upgrade validation.
+Record the revision and hashes; do not modify the candidate during voting.
+
+### Vote and publish through ATR
+
+1. Start the vote in ATR with the pinned candidate revision, release notes,
commit/tag and `KEYS`.
+2. Keep voting open for at least 72 hours and verify the binding-vote tally
before resolving it.
+3. After approval, publish from **Finish** and confirm the official download
URLs.
+4. Complete [Release Maven Repository](#release-maven-repository),
+ [Generate website document](#generate-website-document) and [Something
After Release](#something-after-release).
+ Use ATR's announcement handling.
+
+Details: [Staging and
voting](https://releases.apache.org/docs/staging-and-voting) and
+[Promoting to release](https://releases.apache.org/docs/promoting-to-release).
+
+<a id="upload-to-svn"></a>
+
+## SVN distribution workflow
+
+The following upload steps apply only to the SVN workflow. For ATR, follow
[ATR distribution workflow](#atr-distribution-workflow).
### Upload source code and binary packages to the dev repository
#### Copy source code and binary packages
@@ -364,6 +475,10 @@ svn --username=${APACHE LDAP USERNAME} commit -m "release
${RELEASE.VERSION}"
```
## Vote by mail
+
+The manual vote and result emails below apply only to SVN. For ATR, start and
resolve the vote in the
+[ATR system](https://releases.apache.org/); it handles the corresponding
mailing-list messages.
+
### [email protected] Voting
#### Voting initiate
```bash
@@ -473,6 +588,9 @@ open this page
https://lists.apache.org/[email protected], find
## Official Release
### Moving files
+
+This manual SVN move applies only to the SVN workflow. ATR publishes approved
archives from its Finish page.
+
Moving files from the dev repository to the release repository. This step only
PMC member has permission.
```bash
svn mv https://dist.apache.org/repos/dist/dev/seatunnel/${RELEASE.VERSION}
https://dist.apache.org/repos/dist/release/seatunnel/
@@ -483,9 +601,15 @@
https://github.com/apache/seatunnel-website?tab=readme-ov-file#39-add-a-new-vers
### Release Maven Repository
+
+After the vote passes, release the Maven staging repository for either
distribution workflow.
+

### Send notification email
+
+This manual announcement applies to the SVN workflow. ATR releases use the
configured ATR announcement handling.
+
[[email protected]]([email protected])
[[email protected]]([email protected])