You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by sw...@apache.org on 2024/10/18 05:26:31 UTC
(logging-log4cxx) branch master updated: Prepare the release of a new web site (#417)
This is an automated email from the ASF dual-hosted git repository.
swebb2066 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/logging-log4cxx.git
The following commit(s) were added to refs/heads/master by this push:
new e4abf299 Prepare the release of a new web site (#417)
e4abf299 is described below
commit e4abf299976dc0e0121415f604536d63e08a1009
Author: Stephen Webb <st...@ieee.org>
AuthorDate: Fri Oct 18 16:26:26 2024 +1100
Prepare the release of a new web site (#417)
---
admin/releasing.md | 3 +++
admin/staging.md | 8 ++++----
src/site/CMakeLists.txt | 8 ++++++++
src/site/markdown/change-report-gh.md | 2 +-
src/site/markdown/download.md.in | 34 +++++++++++++---------------------
5 files changed, 29 insertions(+), 26 deletions(-)
diff --git a/admin/releasing.md b/admin/releasing.md
index cff818d1..ea3daeeb 100644
--- a/admin/releasing.md
+++ b/admin/releasing.md
@@ -55,6 +55,9 @@ Steps
1. Tag the released version
- `git checkout v1.3.0-RC1`
- `git push origin tag rel/v1.3.0`
+1. Set your details in `src/site/CMakeLists.txt`
+ - Set your name in the LOG4CXX_RELEASE_MANAGER variable
+ - Set your GnuPG key in the LOG4CXX_RELEASE_MANAGER_KEY variable
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)
diff --git a/admin/staging.md b/admin/staging.md
index 6579b083..afbc0fc2 100644
--- a/admin/staging.md
+++ b/admin/staging.md
@@ -15,7 +15,7 @@ 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`
+ - `git clone --depth=1 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`
@@ -28,7 +28,7 @@ Steps to update the Log4cxx web site
- `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`
+ - `git push origin asf-staging`
1. Check https://logging.staged.apache.org/log4cxx (after a minute or two)
- are you seeing the correct releases page?
@@ -37,7 +37,7 @@ 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`
+ - `git clone --depth=1 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`
@@ -59,7 +59,7 @@ Steps to add a new version to the Log4cxx web site
- `git add .htaccess`
1. Push the `asf-staging` branch to github and wait a bit
- `git commit -m "Add the 1.3.0 documentation"`
- - `git push`
+ - `git push origin asf-staging`
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
diff --git a/src/site/CMakeLists.txt b/src/site/CMakeLists.txt
index ac76bf6d..e15f9d0f 100644
--- a/src/site/CMakeLists.txt
+++ b/src/site/CMakeLists.txt
@@ -21,6 +21,14 @@ if(BUILD_SITE)
find_package( Doxygen REQUIRED dot )
+ set(LOG4CXX_SOURCE_PACKAGE_FILE_NAME "apache-log4cxx-${LOG4CXX_RELEASE_VERSION}")
+ set(LOG4CXX_SOURCE_MIRROR_URL "https://www.apache.org/dyn/closer.cgi/logging/log4cxx/${LOG4CXX_RELEASE_VERSION}/${LOG4CXX_SOURCE_PACKAGE_FILE_NAME}")
+ set(APACHE_LOGGING_DISTRIBUTION_URL "https://www.apache.org/dist/logging")
+ set(LOG4CXX_DOCUMENTATION_URL "https://logging.apache.org/log4cxx")
+ set(LOG4CXX_DISTRIBUTION_URL "${APACHE_LOGGING_DISTRIBUTION_URL}/log4cxx/${LOG4CXX_RELEASE_VERSION}/${LOG4CXX_SOURCE_PACKAGE_FILE_NAME}")
+ set(LOG4CXX_RELEASE_MANAGER "Stephen Webb")
+ set(LOG4CXX_RELEASE_MANAGER_KEY "C6FC425C96722EFC4E2D02D5D4305EBC16B4A78D")
+
configure_file( ${CMAKE_CURRENT_SOURCE_DIR}/doxy/Doxyfile.in
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile )
diff --git a/src/site/markdown/change-report-gh.md b/src/site/markdown/change-report-gh.md
index 7a84fce9..c5b8e9c2 100644
--- a/src/site/markdown/change-report-gh.md
+++ b/src/site/markdown/change-report-gh.md
@@ -25,7 +25,7 @@ Change Log {#changelog}
| Version | Date | Description |
| ------------------- | ---------- | -------------------- |
-| [1.3.0](#rel_1_3_0) | 2024-XX-XX | Maintenance release |
+| [1.3.0](#rel_1_3_0) | 2024-10-21 | Maintenance release |
| [1.2.0](#rel_1_2_0) | 2024-01-01 | Maintenance release |
| [1.1.0](#rel_1_1_0) | 2023-05-01 | General bugfix release |
| [1.0.0](#rel_1_0_0) | 2023-01-01 | Major release to standardize the library and make it ABI stable |
diff --git a/src/site/markdown/download.md.in b/src/site/markdown/download.md.in
index 68051a10..1d28c9b3 100644
--- a/src/site/markdown/download.md.in
+++ b/src/site/markdown/download.md.in
@@ -31,23 +31,23 @@ Download {#download}
| | Mirrors | Checksum | Signature |
|-------------------------|---------|----------|-----------|
-| Apache Log4cxx ${LOG4CXX_RELEASE_VERSION} (tar.gz) | [apache-log4cxx-${LOG4CXX_RELEASE_VERSION}.tar.gz] | [apache-log4cxx-${LOG4CXX_RELEASE_VERSION}.tar.gz.sha512] | [apache-log4cxx-${LOG4CXX_RELEASE_VERSION}.tar.gz.asc] |
-| Apache Log4cxx ${LOG4CXX_RELEASE_VERSION} (zip) | [apache-log4cxx-${LOG4CXX_RELEASE_VERSION}.zip] | [apache-log4cxx-${LOG4CXX_RELEASE_VERSION}.zip.sha512] | [apache-log4cxx-${LOG4CXX_RELEASE_VERSION}.zip.asc] |
+| Apache Log4cxx ${LOG4CXX_RELEASE_VERSION} (tar.gz) | [source archive](${LOG4CXX_SOURCE_MIRROR_URL}.tar.gz) | [sha512](${LOG4CXX_DISTRIBUTION_URL}.tar.gz.sha512) [sha256](${LOG4CXX_DISTRIBUTION_URL}.tar.gz.sha256) | [GnuPG signature](${LOG4CXX_DISTRIBUTION_URL}.tar.gz.asc) |
+| Apache Log4cxx ${LOG4CXX_RELEASE_VERSION} (zip) | [source archive](${LOG4CXX_SOURCE_MIRROR_URL}.zip) | [sha512](${LOG4CXX_DISTRIBUTION_URL}.zip.sha512) [sha256](${LOG4CXX_DISTRIBUTION_URL}.zip.sha256) | [GnuPG signature](${LOG4CXX_DISTRIBUTION_URL}.zip.asc) |
It is essential that you verify the integrity of the downloaded files using the PGP or SHA512 signatures.
Please read [Verifying Apache HTTP Server Releases](https://httpd.apache.org/dev/verification.html) for more
information on why you should verify our releases.
-The PGP signatures can be verified using PGP or GPG. First download the [KEYS](https://www.apache.org/dist/logging/KEYS)
+The PGP signatures can be verified using PGP or GPG. First download the [KEYS](${APACHE_LOGGING_DISTRIBUTION_URL}/KEYS)
as well as the asc signature file for the relevant distribution. Make sure you get these files from the
-[main distribution directory](https://www.apache.org/dist/logging/), rather than from a mirror. Then verify the signatures using:
+[main distribution directory](${APACHE_LOGGING_DISTRIBUTION_URL}/), rather than from a mirror. Then verify the signatures using:
~~~
% gpg --import KEYS
-% gpg --verify apache-log4cxx-${LOG4CXX_RELEASE_VERSION}.tar.gz.asc apache-log4cxx-${LOG4CXX_RELEASE_VERSION}.tar.gz
+% gpg --verify ${LOG4CXX_SOURCE_PACKAGE_FILE_NAME}.tar.gz.asc ${LOG4CXX_SOURCE_PACKAGE_FILE_NAME}.tar.gz
~~~
-* apache-log4cxx-${LOG4CXX_RELEASE_VERSION} is signed by ${releaseManager} (${releaseKey})
+* ${LOG4CXX_SOURCE_PACKAGE_FILE_NAME} is signed by ${LOG4CXX_RELEASE_MANAGER} (${LOG4CXX_RELEASE_MANAGER_KEY})
Alternatively, you can verify the SHA512 signature on the files. A unix program called sha512 or sha512sum is included
in many unix distributions.
@@ -56,18 +56,10 @@ in many unix distributions.
| Version | Release Date |
| :--------------------------: | :----------------------: |
-| [1.2.0](https://logging.apache.org/log4cxx/1.2.0/download.html) | Jan-2024 |
-| [1.1.0](https://logging.apache.org/log4cxx/1.1.0/download.html) | May-2023 |
-| [1.0.0](https://logging.apache.org/log4cxx/1.0.0/download.html) | Jan-2023 |
-| [0.13.0](https://logging.apache.org/log4cxx/0.13.0/download.html) | Aug-2022 |
-| [0.12.1](https://logging.apache.org/log4cxx/0.12.1/download.html) | Sept-2021 |
-| [0.11.0](https://logging.apache.org/log4cxx/0.11.0/download.html) | Aug-2020 |
-| [0.10.0](https://logging.apache.org/log4cxx/0.10.0/download.html) | 2008 |
-
-
-[apache-log4cxx-${LOG4CXX_RELEASE_VERSION}.tar.gz]:https://www.apache.org/dyn/closer.cgi/logging/log4cxx/${LOG4CXX_RELEASE_VERSION}/apache-log4cxx-${LOG4CXX_RELEASE_VERSION}.tar.gz
-[apache-log4cxx-${LOG4CXX_RELEASE_VERSION}.tar.gz.sha512]:https://www.apache.org/dist/logging/log4cxx/${LOG4CXX_RELEASE_VERSION}/apache-log4cxx-${LOG4CXX_RELEASE_VERSION}.tar.gz.sha512
-[apache-log4cxx-${LOG4CXX_RELEASE_VERSION}.tar.gz.asc]:https://www.apache.org/dist/logging/log4cxx/${LOG4CXX_RELEASE_VERSION}/apache-log4cxx-${LOG4CXX_RELEASE_VERSION}.tar.gz.asc
-[apache-log4cxx-${LOG4CXX_RELEASE_VERSION}.zip]:https://www.apache.org/dyn/closer.cgi/logging/log4cxx/${LOG4CXX_RELEASE_VERSION}/apache-log4cxx-${LOG4CXX_RELEASE_VERSION}.zip
-[apache-log4cxx-${LOG4CXX_RELEASE_VERSION}.zip.sha512]:https://www.apache.org/dist/logging/log4cxx/${LOG4CXX_RELEASE_VERSION}/apache-log4cxx-${LOG4CXX_RELEASE_VERSION}.zip.sha512
-[apache-log4cxx-${LOG4CXX_RELEASE_VERSION}.zip.asc]:https://www.apache.org/dist/logging/log4cxx/${LOG4CXX_RELEASE_VERSION}/apache-log4cxx-${LOG4CXX_RELEASE_VERSION}.zip.asc
+| [1.2.0](${LOG4CXX_DOCUMENTATION_URL}/1.2.0/download.html) | Jan-2024 |
+| [1.1.0](${LOG4CXX_DOCUMENTATION_URL}/1.1.0/download.html) | May-2023 |
+| [1.0.0](${LOG4CXX_DOCUMENTATION_URL}/1.0.0/download.html) | Jan-2023 |
+| [0.13.0](${LOG4CXX_DOCUMENTATION_URL}/0.13.0/download.html) | Aug-2022 |
+| [0.12.1](${LOG4CXX_DOCUMENTATION_URL}/0.12.1/download.html) | Sept-2021 |
+| [0.11.0](${LOG4CXX_DOCUMENTATION_URL}/0.11.0/download.html) | Aug-2020 |
+| [0.10.0](${LOG4CXX_DOCUMENTATION_URL}/0.10.0/download.html) | 2008 |