Skip to content

RELEASING.md: add the ATR (Apache Trusted Releases) path - #9264

Merged
rzo1 merged 5 commits into
apache:masterfrom
reiabreu:releasing-md-atr-instructions
Nov 11, 2026
Merged

rzo1 merged 5 commits into
apache:masterfrom
reiabreu:releasing-md-atr-instructions

Conversation

@reiabreu

@reiabreu reiabreu commented Nov 7, 2026 •

Copy link
Copy Markdown
Contributor

Adds ATR to the release process in RELEASING.md, for discussion. The existing SVN steps stay as the alternative, and the four SVN email templates are unchanged.

  • Pick one path: a release manager uses ATR or SVN for a release, never both. The notes say where the paths diverge (staging, vote email, publishing, announcing) and what mixing them does.
  • Website or command line: every ATR step is documented for both. A new section covers the one-time setup (MFA, release manager designation, OpenPGP key, SSH key or personal access token, installing the atr client, the two email template URLs and the download path suffix) and has a table of operations side by side.
  • Steps with an ATR and an SVN variant: staging the candidate (6, 9, 10), starting the vote (11), resolving the vote, publishing, recording the Maven Central release, announcing, archiving, and cleaning up after a failed vote.
  • Unchanged: the Maven release, signing, checksums, release notes, and the Nexus staging repository. ATR does not do these.
  • Expected ATR concern: RELEASE_NOTES.html: Unknown top level file. ATR only accepts CHANGES, LICENSE, NOTICE, README and SECURITY at the top level, and the document says to acknowledge it.

From the 3.2.0 release

  • Download path suffix: Storm is the top-level project of its committee, so with ATR's default the files are published straight into dist/release/storm/, not into apache-storm-x.x.x/. The one-time setup now says to set Default download path suffix to apache-storm-{{VERSION}}, and the publish step says to check it and how to fix a flat publish with one svn mv commit.
  • Email templates: the one-time setup tells the release manager to point ATR's Start vote template URL and Announce release template URL at dev-tools/atr/start-vote-template.txt and dev-tools/atr/announce-template.txt. Both files are added by Add the Storm vote and announcement email templates for ATR #9265, which this PR depends on.

Not verified: staging, the vote, publishing and recording the Maven Central release were done for 3.2.0 with ATR, but the announce step has not been run yet. The command-line variants come from the ATR documentation and the atr client's help, and not all of them have been run. ATR is in beta. This PR stays a draft until the PMC agrees to use ATR for releases.

🤖 Generated with Claude Code

reiabreu and others added 5 commits November 7, 2026 23:03
Document staging, voting, publishing and announcing through ATR, on the
website or from the atr command line. The SVN steps stay as the alternative.
Release managers must pick one path per release and not mix them.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
ATR can fetch the vote email template from a URL. The new
dev-tools/atr/start-vote-template.txt is the Storm template, built from ATR's
default with the Storm specifics from RELEASING.md (Nexus staging repository,
full and lite binaries, how to vote). It is excluded from RAT because it is sent
as an email body. RELEASING.md explains the one-time ATR setting and how the
website form and the command line use it.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
RELEASING.md keeps pointing at dev-tools/atr/start-vote-template.txt, which is
added by that pull request.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Restore the original dist.apache.org URLs in the SVN vote and cancel templates.
ATR users get their vote email from dev-tools/atr/start-vote-template.txt.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
- One-time setup: the announce template URL and subject, and the default download
  path suffix (apache-storm-{{VERSION}}), without which ATR publishes flat into dist/release/storm/.
- Publish step: check the suffix before publishing, and how to fix it afterwards.
- Announce step: the ATR form and command line use dev-tools/atr/announce-template.txt.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@reiabreu
reiabreu marked this pull request as ready for review November 11, 2026 02:02
@rzo1
rzo1 merged commit 678053e into apache:master Nov 11, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants