docs: add the one-time release setup steps to the guidelines - #325
Merged
Conversation
The guidelines listed what a release manager needs access to but never said how to configure any of it, which left the cwiki page "One time steps" as the only description of the signing key, the KEYS file and ~/.m2/settings.xml - and release:perform does not work without them. Port the parts that are still true and drop the rest. The KEYS file now lives in dist/release/struts rather than on people.apache.org, and the SSH key setup that page describes existed for scp deploys to a host that no longer exists. Deviate from the old page on credential handling: it stored the LDAP password and the GPG passphrase in clear text in settings.xml. Point at mvn --encrypt-password and gpg-agent instead. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
Staged site is ready at https://struts.staged.apache.org/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to #324, and a prerequisite for retiring the cwiki release pages.
Why
#324 left the guidelines saying what a release manager needs access to — a signing key, ASF credentials for svn and Nexus — without saying how any of it is configured. That left the cwiki page One time steps as the only place describing the
KEYSfile and~/.m2/settings.xml, andrelease:performdoes not work without them. Stubbing that page before porting this would have deleted a working instruction and put nothing in its place.What's ported
A
Setting up for your first releasesection under Before you start, covering the signing key andKEYS, the Maven settings, andMAVEN_OPTS.Modernised rather than copied:
KEYSmoved. It lives indist/release/strutsnow; the old page appends to a copy insvn.apache.org/repos/asf/struts/maven/trunk/buildandscps it topeople.apache.org.scpdeploys topeople.apache.organd for aknown_hostshashing bug in Maven Wagon — a dead host and a dead code path.settings.xml. This points atmvn --encrypt-passwordandgpg-agentinstead, with a warning callout. Publishing the clear-text version on the project website was not something worth doing.infra.apache.orgrather than the retiredapache.org/dev/paths.The retagging and
svn propsetnotes at the bottom of that page are not ported: both are Subversion-era and the repository has been on git for years.Verified
bundle exec jekyll buildclean. The new###section appears in the generated ToC; its####subsections correctly do not, since_config.ymlsetstoc_levels: 1..3.Next
Once this merges, the seven cwiki release pages get replaced with pointer stubs, as recorded in #324.
🤖 Generated with Claude Code