From 50243625ee1b258f9c01407133f5fff333d358cd Mon Sep 17 00:00:00 2001 From: Amos Jeffries Date: Mon, 20 Feb 2023 07:05:13 +0000 Subject: [PATCH] Maintenance: improve release notes automation (#1264) * auto-update the text version numbers * add template for automatic series creation --- SPONSORS.list | 6 + doc/release-notes/Makefile.am | 8 ++ .../{release-5.sgml => release-5.sgml.in} | 34 +++--- doc/release-notes/template.sgml | 112 ++++++++++++++++++ 4 files changed, 140 insertions(+), 20 deletions(-) rename doc/release-notes/{release-5.sgml => release-5.sgml.in} (93%) create mode 100644 doc/release-notes/template.sgml diff --git a/SPONSORS.list b/SPONSORS.list index 7ff03b7adb..2c691dcfec 100644 --- a/SPONSORS.list +++ b/SPONSORS.list @@ -163,6 +163,12 @@ SGI - http://www.sgi.com/ SGI has provided hardware donations for Squid developers. @Squid-2.3: +National Laboratory for Applied Network Research + + NLANR coordinated the early development of Squid + with features for integration with the IRCache network + measurement project and High Performance Networking. + The National Science Foundation The NSF was the primary funding source for Squid development diff --git a/doc/release-notes/Makefile.am b/doc/release-notes/Makefile.am index 38c83b0d81..8c02db8595 100644 --- a/doc/release-notes/Makefile.am +++ b/doc/release-notes/Makefile.am @@ -19,6 +19,14 @@ DOC= release-5 # latex $(DOC).tex # +%.sgml: %.sgml.in + sed \ + -e "s%[@]SQUID_VERSION[@]%$(VERSION)%g" \ + -e "s%[@]SQUID_RELEASE[@]%$(SQUID_RELEASE)%g" \ + -e "s%[@]SQUID_RELEASE_OLD[@]%$$(( $(SQUID_RELEASE) - 1 ))%g" \ + < $< >$@ + test `grep -c "@SQUID" $@` -eq 0 + %.txt: %.sgml linuxdoc -B txt --filter $< diff --git a/doc/release-notes/release-5.sgml b/doc/release-notes/release-5.sgml.in similarity index 93% rename from doc/release-notes/release-5.sgml rename to doc/release-notes/release-5.sgml.in index 8a76200f10..58bc569eb0 100644 --- a/doc/release-notes/release-5.sgml +++ b/doc/release-notes/release-5.sgml.in @@ -1,36 +1,30 @@
-Squid 5.7 release notes +Squid @SQUID_VERSION@ release notes Squid Developers - -This document contains the release notes for version 5 of Squid. -Squid is a WWW Cache application developed by the National Laboratory -for Applied Network Research and members of the Web Caching community. - - Notice -

The Squid Team are pleased to announce the release of Squid-5.7. +

The Squid Team are pleased to announce the release of Squid-@SQUID_VERSION@. -This new release is available for download from or the +This new release is available for download from or the . -

We welcome feedback and bug reports. If you find a bug, please see +

We welcome feedback and bug reports. If you find a bug, please see for how to submit a report with a stack trace. Known issues

Although this release is deemed good enough for use in many setups, please note the existence of -. +. -Changes since earlier releases of Squid-5 +Changes since earlier releases of Squid-@SQUID_RELEASE@

-The Squid-5 change history can be . +The Squid-@SQUID_RELEASE@ change history can be . -Major new features since Squid-4 -

Squid-5 represents a new feature release above Squid-4. +Major new features since Squid-@SQUID_RELEASE_OLD@ +

Squid-@SQUID_RELEASE@ represents a new feature release above Squid-@SQUID_RELEASE_OLD@.

The most important of these new features are: @@ -165,9 +159,9 @@ Most user-facing changes are reflected in squid.conf (see below).

OpenSSL 3.0 uses new licensing terms. -Changes to squid.conf since Squid-4 +Changes to squid.conf since Squid-@SQUID_RELEASE_OLD@

-There have been changes to Squid's configuration file since Squid-4. +There have been changes to Squid's configuration file since Squid-@SQUID_RELEASE_OLD@. This section gives a thorough account of those changes in three categories: @@ -326,9 +320,9 @@ This section gives a thorough account of those changes in three categories: -Changes to ./configure options since Squid-4 +Changes to ./configure options since Squid-@SQUID_RELEASE_OLD@

-There have been some changes to Squid's build configuration since Squid-4. +There have been some changes to Squid's build configuration since Squid-@SQUID_RELEASE_OLD@. This section gives an account of those changes in three categories: @@ -379,7 +373,7 @@ This section gives an account of those changes in three categories: Regressions since Squid-2.7 -

Some squid.conf options which were available in Squid-2.7 are not yet available in Squid-5 +

Some squid.conf options which were available in Squid-2.7 are not yet available in Squid-@SQUID_RELEASE@

If you need something to do then porting one of these from Squid-2 is most welcome. diff --git a/doc/release-notes/template.sgml b/doc/release-notes/template.sgml new file mode 100644 index 0000000000..0955ace31f --- /dev/null +++ b/doc/release-notes/template.sgml @@ -0,0 +1,112 @@ + +

+Squid @SQUID_VERSION@ release notes +Squid Developers + + + +Notice +

The Squid Team are pleased to announce the release of Squid-@PACKAGE_VERSION@ for testing. + +This new release is available for download from or the + . + +

While this release is not deemed ready for production use, we believe it is ready for wider testing by the community. + +

We welcome feedback and bug reports. If you find a bug, please see + for how to submit a report with a stack trace. + +Known issues +

Although this release is deemed good enough for use in many setups, please note the existence of +. + +Changes since earlier releases of Squid-@SQUID_RELEASE@ +

+The Squid-@SQUID_RELEASE@ change history can be . + + +Major new features since Squid-@SQUID_RELEASE_OLD@ +

Squid-@SQUID_RELEASE@ represents a new feature release above Squid-@SQUID_RELEASE_OLD@. + +

The most important of these new features are: + + + + +Most user-facing changes are reflected in squid.conf (see below). + + +Changes to squid.conf since Squid-@SQUID_RELEASE_OLD@ +

+This section gives an account of those changes in three categories: + + + + + + +

+ +New directives

+ +

No new directives in this version. + + + +Changes to existing directives

+ +

No changed directives in this version. + + + +Removed directives

+ +

No removed directives in this version. + + + + +Changes to ./configure options since Squid-@SQUID_RELEASE_OLD@ +

+This section gives an account of those changes in three categories: + + + + + + + +New options

+ +

No new options in this version. + + + +Changes to existing options

+ +

No changed options in this version. + + +

+ +Removed options
-- 2.47.2