This is an automated email from the ASF dual-hosted git repository. swebb2066 pushed a commit to branch document_release_process in repository https://gitbox.apache.org/repos/asf/logging-log4cxx.git
commit de1d1d844f1d653d36dbda83e927c3eb8f391cfa Author: Stephen Webb <[email protected]> AuthorDate: Wed Oct 9 15:46:31 2024 +1100 Provide guidelines and templates for the release process --- admin/MailTemplate.Announce.txt | 11 +++++++ admin/MailTemplate.Result.txt | 14 +++++++++ admin/MailTemplate.txt | 20 +++++++++++++ admin/releasing.md | 66 +++++++++++++++++++++++++++++++++++++++++ admin/staging.md | 64 +++++++++++++++++++++++++++++++++++++++ 5 files changed, 175 insertions(+) diff --git a/admin/MailTemplate.Announce.txt b/admin/MailTemplate.Announce.txt new file mode 100644 index 00000000..01ecdf28 --- /dev/null +++ b/admin/MailTemplate.Announce.txt @@ -0,0 +1,11 @@ +To: [email protected], [email protected] +Subject: [ANNOUNCE] Apache log4cxx 1.3.0 released + +Hi, + +the Apache log4cxx team is pleased to announce the 1.3.0 release. +For further information (support, download, etc.) see +- https://logging.apache.org/log4cxx/1.3.0/changelog.html +- https://dist.apache.org/repos/dist/dev/logging/log4cxx + +== Release Notes \ No newline at end of file diff --git a/admin/MailTemplate.Result.txt b/admin/MailTemplate.Result.txt new file mode 100644 index 00000000..e1e93bc5 --- /dev/null +++ b/admin/MailTemplate.Result.txt @@ -0,0 +1,14 @@ +To: [email protected] +Subject: [RESULT][VOTE] Release Apache Log4cxx 1.3.0 + +and here is my +1. + +With that the vote passed with 3 +1 votes from ... and myself. +I will continue the release process. + +Stephen + +--------------------------------------------------------------------------------------------------- +This is a vote to release the Apache Log4cxx 1.3.0. + +... \ No newline at end of file diff --git a/admin/MailTemplate.txt b/admin/MailTemplate.txt new file mode 100644 index 00000000..e721288e --- /dev/null +++ b/admin/MailTemplate.txt @@ -0,0 +1,20 @@ +To: [email protected] +Subject: [VOTE] Release Apache Log4cxx 1.3.0 + +This is a vote to release the Apache Log4cxx 1.3.0. + +Website: https://logging.staged.apache.org/log4cxx/1.3.0/changelog.html +GitHub: https://github.com/apache/logging-log4cxx +Commit: <todo insert> +Distribution: https://dist.apache.org/repos/dist/dev/logging/log4cxx +Signing key: C6FC425C96722EFC4E2D02D5D4305EBC16B4A78D +Review kit: https://github.com/apache/logging-log4cxx/admin/release-review-instructions.md + +Please download, test, and cast your votes on this mailing list. + +[ ] +1, release the artifacts +[ ] -1, don't release, because ... + +This vote is open for 72 hours and will pass unless getting a net negative vote count. +All votes are welcome and we encourage everyone to test the release, but only the +Logging Services PMC votes are officially counted. diff --git a/admin/releasing.md b/admin/releasing.md new file mode 100644 index 00000000..3b52b594 --- /dev/null +++ b/admin/releasing.md @@ -0,0 +1,66 @@ +Releasing a Log4cxx version +=================== + +This document lists the steps that must be performed to release Log4cxx +using 1.3.0 as the example. + +Prerequisites +---------- + +* The version number (in src/cmake/projectVersionDetails.cmake) has been updated +* The change log (in src/site/markdown/change-report-gh.md) is up-to-date. +* The web-site for the new version has been published to https://logging.staged.apache.org/log4cxx +* An e-mail has been sent to [email protected] announcing the intention to release +* Your public key is available in [Apache Logging KEYS file](https://dist.apache.org/repos/dist/release/logging/KEYS) + +Steps +----- + +1. Tag HEAD as the release candidate + - `git checkout master` + - `git tag v1.3.0-RC1` + - `git push` +1. get the artifacts in build/artifacts up to https://downloads.apache.org/logging/log4cxx/ + - `svn co https://dist.apache.org/repos/dist/dev/logging -N apache-dist-logging-dev` + - `cd apache-dist-logging-dev` + - `svn up log4cxx` + - `cd log4cxx` + - `svn delete *` +1. Download the latest release artifacts + - The link to the packaged artifacts is available + in the Github action log under the "Run action/upload-artifact" step of + the "Generate release files" Github action. + The log of the most recent commit can be accessed + using the "Details" link in the pop-up window shown + when the green tick is clicked. + - `cd apache-dist-logging-dev/log4cxx` + - `unzip "/tmp/Upload release files.zip"` +1. Sign release artifacts (Refer: https://infra.apache.org/release-signing.html) +(apache-log4cxx-X.X.X.zip & apache-log4cxx-X.X.X.tar.tgz) + - `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` + - `svn add *` + - `svn commit -m 'log4cxx 1.3.0'` + - check https://dist.apache.org/repos/dist/dev/logging/log4cxx +1. raise a vote on the log4cxx mailing list ([email protected]) - see MailTemplate.txt +1. wait +1. when the vote has 3 or more +1's, it's time to go live! +1. copy the apache artifacts to the release svn repo and commit + - `svn co https://dist.apache.org/repos/dist/release/logging -N apache-dist-logging-release` + - `cd apache-dist-logging-release` + - `svn up log4cxx` + - `cd log4cxx` + - copy in artifacts + - `svn add 1.3.0` + - `svn commit` +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 checkout asf-site` + - `git rebase asf-staging` + - `git push origin asf-site` +1. Tag the released version + - `git checkout v1.3.0-RC1` + - `git tag rel/v1.3.0` + - `git push` +1. \ No newline at end of file diff --git a/admin/staging.md b/admin/staging.md new file mode 100644 index 00000000..1fb7b850 --- /dev/null +++ b/admin/staging.md @@ -0,0 +1,64 @@ +Updating the Log4cxx web site +=================== + +This document describes the steps used to update Log4cxx web site +using 1.3.0 as an example Log4cxx version. + +Prerequisites +---------- + +* The documentaion changes have been committed to the log4cxx source code repository +* Doxygen 1.9.6 in available on your system +* APR and APR-Util are available on your system + +Steps to update the Log4cxx web site +----- + +1. Use Doxygen to generate the HTML, PNG, JS and CSS files + - `git clone https://github.com/apache/logging-log4cxx /tmp/log4cxx` + - `cmake -B /tmp/build -S /tmp/log4cxx -DBUILD_SITE=on` + - `cmake --build /tmp/build -t doc_doxygen` +1. Check out the `asf-staging` branch of `logging-log4cxx-site` + - `git clone https://github.com/apache/logging-log4cxx-site /tmp/log4cxx-site` + - `cd /tmp/log4cxx-site` + - `git checkout asf-staging` +1. Remove the previously generated files from the web site working directory + - `git rm 1.3.0` +1. Move the newly generated files to the web site working directory + - `mv /tmp/build/src/site/html 1.3.0` + - `git add 1.3.0` +1. push the `asf-staging` branch to Github and wait a bit + - `git commit -m "Improved the ... documentation"` + - `git push` +1. Check https://logging.staged.apache.org/log4cxx (after a minute or two) + - are you seeing the correct releases page? + + +Steps to add a new version to the Log4cxx web site +----- + +1. Use Doxygen to generate the HTML, PNG, JS and CSS files + - `git clone https://github.com/apache/logging-log4cxx /tmp/log4cxx` + - `cmake -B /tmp/build -S /tmp/log4cxx -DBUILD_SITE=on` + - `cmake --build /tmp/build -t doc_doxygen` +1. Check out the `asf-staging` branch of `logging-log4cxx-site` + - `git clone https://github.com/apache/logging-log4cxx-site /tmp/log4cxx-site` + - `cd /tmp/log4cxx-site` + - `git checkout asf-staging` +1. Move the generated files to the web site working directory + - `mv /tmp/build/src/site/html /tmp/log4cxx-site/1.3.0` +1. Update the symbolic links in the base of the web site working directory + - `cd /tmp/log4cxx-site` + - `rm latest_stable old_stable` + - `ln -s 1.3.0 latest_stable` + - `ln -s 1.2.0 old_stable` +1. Update `.htaccess` so the final `RewriteRule` redirects to the new version + - `RewriteRule ^(.*)$ /log4cxx/1.3.0/$1 [R=temp,L]` +1. push the `asf-staging` branch to github and wait a bit + - `git add 1.3.0 latest_stable old_stable .htaccess` + - `git commit -m "Add the 1.3.0 documentation"` + - `git push` +1. Check https://logging.staged.apache.org/log4cxx (after a minute or two) + - Are you seeing the new pages? + - Download links for the new version should (at this point) not work +
