Skip to content

Commit

Permalink
Improve guidelines and templates for the release process
Browse files Browse the repository at this point in the history
  • Loading branch information
stephen-webb committed Oct 18, 2024
1 parent e4abf29 commit 9c2681f
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 9 deletions.
17 changes: 10 additions & 7 deletions admin/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ Steps
- `svn up log4cxx`
- `cd log4cxx`
- `svn delete *`
- `mkdir 1.3.0`
- `svn add 1.3.0`
- `cd 1.3.0`
1. Download the packaged release files from Github
- Open https://github.com/apache/logging-log4cxx/commits/v1.3.0-RC1 in your web browser
- Click the green tick mark on the top commit
Expand All @@ -35,13 +38,12 @@ Steps
- The numbered steps will display
- Click the link next to `Artifact download URL:`
- The browser will download the file `Upload release files.zip` onto your system
1. Unpack the release files using these commands
- `cd apache-dist-logging-dev/log4cxx`
1. Unpack the release files using these commands (with `apache-dist-logging-dev/log4cxx/1.3.0` as the working directory)
- `unzip "$HOME/Downloads/Upload release files.zip"`
1. Sign release artifacts (Refer: https://infra.apache.org/release-signing.html) (with `apache-dist-logging-dev/log4cxx` as the working directory)
1. Sign release artifacts (Refer: https://infra.apache.org/release-signing.html) (with `apache-dist-logging-dev/log4cxx/1.3.0` as the working directory)
- `gpg --armor --output apache-log4cxx-1.3.0.zip.asc --detach-sig apache-log4cxx-1.3.0.zip`
- `gpg --armor --output apache-log4cxx-1.3.0.tar.gz.asc --detach-sig apache-log4cxx-1.3.0.tar.gz`
1. Send the new artifacts to svn (with `apache-dist-logging-dev/log4cxx` as the working directory)
1. Send the new artifacts to svn (with `apache-dist-logging-dev/log4cxx/1.3.0` as the working directory)
- `svn add *`
- `svn commit -m 'log4cxx 1.3.0'`
- check https://dist.apache.org/repos/dist/dev/logging/log4cxx
Expand All @@ -51,7 +53,7 @@ Steps
1. When the vote has 3 or more +1's, announce the result
- Using [this template](MailTemplate.Result.txt)
1. Get artifacts up to https://downloads.apache.org/logging/log4cxx/
- `svn move -m "Release log4cxx 1.3.0" https://dist.apache.org/repos/dist/dev/logging/log4cxx https://dist.apache.org/repos/dist/release/logging/log4cxx/1.3.0`
- `svn move -m "Release log4cxx 1.3.0" https://dist.apache.org/repos/dist/dev/logging/log4cxx/1.3.0 https://dist.apache.org/repos/dist/release/logging/log4cxx/`
1. Tag the released version
- `git checkout v1.3.0-RC1`
- `git push origin tag rel/v1.3.0`
Expand All @@ -61,14 +63,15 @@ Steps
1. Enter the release date in `src/site/markdown/change-report-gh.md`
- Commit the change
- Update the staged web site using [the update procedure](staging.md)
1. Check the staged web site is ready to go live
1. Check the staged web site (https://logging.staged.apache.org/log4cxx) is ready to go live
- Are you are seeing the release date on changelog?
- Do the links on download page work?
1. Make the new version of the web site live.
- `git clone https://github.com/apache/logging-log4cxx-site /tmp/log4cxx-site`
- `cd /tmp/log4cxx-site`
- `git fetch origin asf-staging`
- `git rebase origin/asf-staging`
- `git checkout asf-site`
- `git rebase asf-staging`
- `git push origin asf-site`
1. Check https://logging.apache.org/log4cxx (after a minute or two)
- Are you seeing the new pages?
Expand Down
8 changes: 6 additions & 2 deletions admin/validate-release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,12 @@ if [ -z "$VERSION" ] ; then
VERSION=1.3.0
fi

if [ -z "$STAGE" ] ; then
STAGE=dev # Alternatively release
fi

if [ -z "$BASE_DL" ] ; then
BASE_DL=https://dist.apache.org/repos/dist/dev/logging/log4cxx
BASE_DL=https://dist.apache.org/repos/dist/$STAGE/logging/log4cxx
fi
if [ -z "$ARCHIVE" ] ; then
ARCHIVE=apache-log4cxx-$VERSION
Expand All @@ -20,7 +24,7 @@ fi
test -d "$TEST_DIRECTORY" || mkdir "$TEST_DIRECTORY"
cd "$TEST_DIRECTORY"

FULL_DL="$BASE_DL/$ARCHIVE"
FULL_DL="$BASE_DL/$VERSION/$ARCHIVE"

for EXT in "tar.gz" "zip" ; do
wget "$FULL_DL.$EXT" || exit $?
Expand Down

0 comments on commit 9c2681f

Please sign in to comment.