From e40bd273e474a0562bcabccbb193ae1074443e3d Mon Sep 17 00:00:00 2001 From: Michal Nowak Date: Thu, 24 Oct 2024 17:01:57 +0200 Subject: [PATCH] Remove the CHANGES file With the introduction of the generated changelog, the CHANGES file became a symlink to doc/arm/changelog.rst. After the changes made in !9549, the changelog file transitioned from being a wholly generated file to one that includes versioned changelog files, which are themselves generated. However, while implementing !9549, we overlooked that the CHANGES file is copied to a release directory on an FTP server and contains just "include" directives, not the changelog itself. Therefore, in the same fashion as the "RELEASE-NOTES*.html" file, create a "CHANGELOG*.html" file that redirects to the Changelog appendix of the ARM. --- .gitlab-ci.yml | 3 ++- .reuse/dep5 | 1 - CHANGES | 1 - Makefile.am | 1 - README.md | 2 +- doc/arm/changelog.rst | 2 +- 6 files changed, 4 insertions(+), 6 deletions(-) delete mode 120000 CHANGES diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 55f58ff330..f580f1ddc2 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1455,11 +1455,12 @@ release: - pushd "${BIND_DIRECTORY}-release" - mv "../${BIND_DIRECTORY}.tar.xz" . - tar --extract --file="${BIND_DIRECTORY}.tar.xz" - - mv "${BIND_DIRECTORY}"/{CHANGES*,COPYRIGHT,LICENSE,README.md,srcid} . + - mv "${BIND_DIRECTORY}"/{COPYRIGHT,LICENSE,README.md,srcid} . - rm -rf "${BIND_DIRECTORY}" - mv "../doc/arm/_build/html" doc/arm/ - mv "../doc/arm/_build/epub/Bv9ARM.epub" doc/arm/ - echo 'Redirect' > "RELEASE-NOTES-${BIND_DIRECTORY}.html" + - echo 'Redirect' > "CHANGELOG-${BIND_DIRECTORY}.html" - popd needs: - job: tarball-create diff --git a/.reuse/dep5 b/.reuse/dep5 index e18e08276f..e17eb58f45 100644 --- a/.reuse/dep5 +++ b/.reuse/dep5 @@ -26,7 +26,6 @@ Files: **/*.after* .gitlab/* .mailmap AUTHORS - CHANGES COPYRIGHT Makefile Makefile.* diff --git a/CHANGES b/CHANGES deleted file mode 120000 index d0de56f114..0000000000 --- a/CHANGES +++ /dev/null @@ -1 +0,0 @@ -doc/arm/changelog.rst \ No newline at end of file diff --git a/Makefile.am b/Makefile.am index df91934e03..9a81318050 100644 --- a/Makefile.am +++ b/Makefile.am @@ -21,7 +21,6 @@ EXTRA_DIST = \ util/bindkeys.pl \ util/dtrace.sh \ contrib \ - CHANGES \ COPYRIGHT \ LICENSE \ *.md diff --git a/README.md b/README.md index 4bfe45ddc1..16ede04c17 100644 --- a/README.md +++ b/README.md @@ -163,7 +163,7 @@ Additional information on various subjects can be found in other #### Bug report identifiers -Most notes in the CHANGES file include a reference to a bug report or +Most notes in the ARM Changelog appendix include a reference to a bug report or issue number. Prior to 2018, these were usually of the form `[RT #NNN]` and referred to entries in the "bind9-bugs" RT database, which was not open to the public. More recent entries use the form `[GL #NNN]` or, less often, diff --git a/doc/arm/changelog.rst b/doc/arm/changelog.rst index 22439522bd..3b0cabef00 100644 --- a/doc/arm/changelog.rst +++ b/doc/arm/changelog.rst @@ -14,7 +14,7 @@ Changelog ========= -.. note:: The following list contains detailed information about BIND9's +.. note:: The following list contains detailed information about BIND 9 development. Regular users should refer to :ref:`Release Notes ` for changes relevant to them.