]> git.ipfire.org Git - thirdparty/squid.git/commitdiff
Maintenance: improve release notes automation (#1264)
authorAmos Jeffries <yadij@users.noreply.github.com>
Mon, 20 Feb 2023 07:05:13 +0000 (07:05 +0000)
committerSquid Anubis <squid-anubis@squid-cache.org>
Tue, 21 Feb 2023 07:32:26 +0000 (07:32 +0000)
* auto-update the text version numbers
* add template for automatic series creation

SPONSORS.list
doc/release-notes/Makefile.am
doc/release-notes/release-5.sgml.in [moved from doc/release-notes/release-5.sgml with 93% similarity]
doc/release-notes/release-6.sgml.in [moved from doc/release-notes/release-6.sgml with 94% similarity]
doc/release-notes/template.sgml [new file with mode: 0644]

index 7ff03b7adb2fe8dd0ff72e435bba63b004a39e1e..2c691dcfec9ef05baec3d3d5766262acb7ece0c3 100644 (file)
@@ -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
index b5821c857ed0237eff01b8bcfb9eceb0d82f7d65..8be79124db18642c31bcd4d7f1c947227159852a 100644 (file)
@@ -10,6 +10,14 @@ if ENABLE_RELEASE_DOCS
 
 DOC= release-$(SQUID_RELEASE)
 
+%.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 $<
 
similarity index 93%
rename from doc/release-notes/release-5.sgml
rename to doc/release-notes/release-5.sgml.in
index 3929c118606a2bb0a91f0ddc0377677e464d6c5d..1705620486ecd0302408398692e9fdee9c025e68 100644 (file)
@@ -1,36 +1,30 @@
 <!doctype linuxdoc system>
 <article>
-<title>Squid 5.7 release notes</title>
+<title>Squid @SQUID_VERSION@ release notes</title>
 <author>Squid Developers</author>
 
-<abstract>
-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.
-</abstract>
-
 <toc>
 
 <sect>Notice
-<p>The Squid Team are pleased to announce the release of Squid-5.7.
+<p>The Squid Team are pleased to announce the release of Squid-@SQUID_VERSION@.
 
-This new release is available for download from <url url="http://www.squid-cache.org/Versions/v5/"> or the
+This new release is available for download from <url url="http://www.squid-cache.org/Versions/v@SQUID_RELEASE@/"> or the
  <url url="http://www.squid-cache.org/Download/http-mirrors.html" name="mirrors">.
 
-<p>We welcome feedback and bug reports. If you find a bug, please see <url url="http://wiki.squid-cache.org/SquidFaq/BugReporting">
+<p>We welcome feedback and bug reports. If you find a bug, please see <url url="https://wiki.squid-cache.org/SquidFaq/BugReporting">
    for how to submit a report with a stack trace.
 
 <sect1>Known issues
 <p>Although this release is deemed good enough for use in many setups, please note the existence of 
-<url url="http://bugs.squid-cache.org/buglist.cgi?query_format=advanced&amp;product=Squid&amp;bug_status=UNCONFIRMED&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;version=5" name="open bugs against Squid-5">.
+<url url="https://bugs.squid-cache.org/buglist.cgi?query_format=advanced&amp;product=Squid&amp;bug_status=UNCONFIRMED&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;version=@SQUID_RELEASE@" name="open bugs against Squid-@SQUID_RELEASE@">.
 
-<sect1>Changes since earlier releases of Squid-5
+<sect1>Changes since earlier releases of Squid-@SQUID_RELEASE@
 <p>
-The Squid-5 change history can be <url url="http://www.squid-cache.org/Versions/v5/changesets/" name="viewed here">.
+The Squid-@SQUID_RELEASE@ change history can be <url url="https://github.com/squid-cache/squid/commits/v@SQUID_RELEASE@" name="viewed here">.
 
 
-<sect>Major new features since Squid-4
-<p>Squid-5 represents a new feature release above Squid-4.
+<sect>Major new features since Squid-@SQUID_RELEASE_OLD@
+<p>Squid-@SQUID_RELEASE@ represents a new feature release above Squid-@SQUID_RELEASE_OLD@.
 
 <p>The most important of these new features are:
 <itemize>
@@ -165,9 +159,9 @@ Most user-facing changes are reflected in squid.conf (see below).
 <p>OpenSSL 3.0 uses new licensing terms.
 
 
-<sect>Changes to squid.conf since Squid-4
+<sect>Changes to squid.conf since Squid-@SQUID_RELEASE_OLD@
 <p>
-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:
 </descrip>
 
 
-<sect>Changes to ./configure options since Squid-4
+<sect>Changes to ./configure options since Squid-@SQUID_RELEASE_OLD@
 <p>
-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:
 
@@ -385,7 +379,7 @@ This section gives an account of those changes in three categories:
 
 <sect>Regressions since Squid-2.7
 
-<p>Some squid.conf options which were available in Squid-2.7 are not yet available in Squid-5
+<p>Some squid.conf options which were available in Squid-2.7 are not yet available in Squid-@SQUID_RELEASE@
 
 <p>If you need something to do then porting one of these from Squid-2 is most welcome.
 
similarity index 94%
rename from doc/release-notes/release-6.sgml
rename to doc/release-notes/release-6.sgml.in
index 6856d643ed3b21cfcd8376441b3a973caa7fb778..05a1f81a7624abb2bca683c017f986febfcac5b4 100644 (file)
@@ -1,21 +1,14 @@
 <!doctype linuxdoc system>
 <article>
-<title>Squid 6.0.1 release notes</title>
+<title>Squid @SQUID_VERSION@ release notes</title>
 <author>Squid Developers</author>
 
-<abstract>
-This document contains the release notes for version 6 of Squid.
-Squid is a WWW Cache application developed by the National Laboratory
-for Applied Network Research and members of the Web Caching community.
-</abstract>
-
 <toc>
 
-
 <sect>Notice
-<p>The Squid Team are pleased to announce the release of Squid-6.0.1 for testing.
+<p>The Squid Team are pleased to announce the release of Squid-@SQUID_VERSION@ for testing.
 
-This new release is available for download from <url url="http://www.squid-cache.org/Versions/v6/"> or the
+This new release is available for download from <url url="http://www.squid-cache.org/Versions/v@SQUID_RELEASE@/"> or the
  <url url="http://www.squid-cache.org/Download/http-mirrors.html" name="mirrors">.
 
 <p>While this release is not deemed ready for production use, we believe it is ready for wider testing by the community.
@@ -25,7 +18,7 @@ This new release is available for download from <url url="http://www.squid-cache
 
 <sect1>Known issues
 <p>Although this release is deemed good enough for use in many setups, please note the existence of
-<url url="http://bugs.squid-cache.org/buglist.cgi?query_format=advanced&amp;product=Squid&amp;bug_status=UNCONFIRMED&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;version=6" name="open bugs against Squid-6">.
+<url url="http://bugs.squid-cache.org/buglist.cgi?query_format=advanced&amp;product=Squid&amp;bug_status=UNCONFIRMED&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;version=@SQUID_RELEASE@" name="open bugs against Squid-@SQUID_RELEASE@">.
 
 <p>Support for compiling on HPUX with the native HP <em>xcc</em> compiler has been removed.
   To build on that OS/compiler combination, it is possible to pass these environment variables
@@ -34,13 +27,13 @@ This new release is available for download from <url url="http://www.squid-cache
 <p>This release adds a dependency on C++17 support in any compiler used to build Squid.
   GCC 8+ and Clang 8+ support C++17.
 
-<sect1>Changes since earlier releases of Squid-6
+<sect1>Changes since earlier releases of Squid-@SQUID_RELEASE@
 <p>
-The Squid-6 change history can be <url url="https://github.com/squid-cache/squid/commits/v6" name="viewed here">.
+The Squid-@SQUID_RELEASE@ change history can be <url url="https://github.com/squid-cache/squid/commits/v@SQUID_RELEASE@" name="viewed here">.
 
 
-<sect>Major new features since Squid-5
-<p>Squid-6 represents a new feature release above Squid-5.
+<sect>Major new features since Squid-@SQUID_RELEASE_OLD@
+<p>Squid-@SQUID_RELEASE@ represents a new feature release above Squid-@SQUID_RELEASE_OLD@.
 
 <p>The most important of these new features are:
 <itemize>
@@ -196,7 +189,7 @@ The Squid-6 change history can be <url url="https://github.com/squid-cache/squid
 </itemize>
 
 
-<sect>Changes to squid.conf since Squid-5
+<sect>Changes to squid.conf since Squid-@SQUID_RELEASE_OLD@
 <p>
 This section gives an account of those changes in three categories:
 
@@ -286,7 +279,7 @@ This section gives an account of those changes in three categories:
 </descrip>
 
 
-<sect>Changes to ./configure options since Squid-5
+<sect>Changes to ./configure options since Squid-@SQUID_RELEASE_OLD@
 <p>
 This section gives an account of those changes in three categories:
 
@@ -354,7 +347,7 @@ This section gives an account of those changes in three categories:
 
 <sect>Regressions since Squid-2.7
 
-<p>Some squid.conf options which were available in Squid-2.7 are not yet available in Squid-6.
+<p>Some squid.conf options which were available in Squid-2.7 are not yet available in Squid-@SQUID_RELEASE@.
 
 <p>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 (file)
index 0000000..0955ace
--- /dev/null
@@ -0,0 +1,112 @@
+<!doctype linuxdoc system>
+<article>
+<title>Squid @SQUID_VERSION@ release notes</title>
+<author>Squid Developers</author>
+
+<toc>
+
+<sect>Notice
+<p>The Squid Team are pleased to announce the release of Squid-@PACKAGE_VERSION@ for testing.
+
+This new release is available for download from <url url="http://www.squid-cache.org/Versions/v@SQUID_RELEASE@/"> or the
+ <url url="http://www.squid-cache.org/Download/http-mirrors.html" name="mirrors">.
+
+<p>While this release is not deemed ready for production use, we believe it is ready for wider testing by the community.
+
+<p>We welcome feedback and bug reports. If you find a bug, please see <url url="https://wiki.squid-cache.org/SquidFaq/BugReporting">
+   for how to submit a report with a stack trace.
+
+<sect1>Known issues
+<p>Although this release is deemed good enough for use in many setups, please note the existence of
+<url url="https://bugs.squid-cache.org/buglist.cgi?query_format=advanced&amp;product=Squid&amp;bug_status=UNCONFIRMED&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;version=@SQUID_RELEASE@" name="open bugs against Squid-@SQUID_RELEASE@">.
+
+<sect1>Changes since earlier releases of Squid-@SQUID_RELEASE@
+<p>
+The Squid-@SQUID_RELEASE@ change history can be <url url="https://github.com/squid-cache/squid/commits/v@SQUID_RELEASE@" name="viewed here">.
+
+
+<sect>Major new features since Squid-@SQUID_RELEASE_OLD@
+<p>Squid-@SQUID_RELEASE@ represents a new feature release above Squid-@SQUID_RELEASE_OLD@.
+
+<p>The most important of these new features are:
+<itemize>
+       <item>
+</itemize>
+
+Most user-facing changes are reflected in squid.conf (see below).
+
+
+<sect>Changes to squid.conf since Squid-@SQUID_RELEASE_OLD@
+<p>
+This section gives an account of those changes in three categories:
+
+<itemize>
+       <item><ref id="newdirectives" name="New directives">
+       <item><ref id="modifieddirectives" name="Changes to existing directives">
+       <item><ref id="removeddirectives" name="Removed directives">
+</itemize>
+<p>
+
+<sect1>New directives<label id="newdirectives">
+<p>
+<descrip>
+       <p>No new directives in this version.
+
+</descrip>
+
+<sect1>Changes to existing directives<label id="modifieddirectives">
+<p>
+<descrip>
+       <p>No changed directives in this version.
+
+</descrip>
+
+<sect1>Removed directives<label id="removeddirectives">
+<p>
+<descrip>
+       <p>No removed directives in this version.
+
+</descrip>
+
+
+<sect>Changes to ./configure options since Squid-@SQUID_RELEASE_OLD@
+<p>
+This section gives an account of those changes in three categories:
+
+<itemize>
+       <item><ref id="newoptions" name="New options">
+       <item><ref id="modifiedoptions" name="Changes to existing options">
+       <item><ref id="removedoptions" name="Removed options">
+</itemize>
+
+<sect1>New options<label id="newoptions">
+<p>
+<descrip>
+       <p>No new options in this version.
+
+</descrip>
+
+<sect1>Changes to existing options<label id="modifiedoptions">
+<p>
+<descrip>
+       <p>No changed options in this version.
+
+</descrip>
+</p>
+
+<sect1>Removed options<label id="removedoptions">
+<p>
+<descrip>
+       <p>No removed options in this version.
+
+</descrip>
+
+<sect>Copyright
+<p>
+Copyright (C) 1996-2023 The Squid Software Foundation and contributors
+<p>
+Squid software is distributed under GPLv2+ license and includes
+contributions from numerous individuals and organizations.
+Please see the COPYING and CONTRIBUTORS files for details.
+
+</article>