From 5e204e3fd88c38eafa95220d362843c343387360 Mon Sep 17 00:00:00 2001 From: Daan van Berkel Date: Thu, 1 Oct 2026 17:28:32 +0200 Subject: [PATCH 1/6] Have a sensible default as CHANGES.md --- templates/CHANGES.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/templates/CHANGES.md b/templates/CHANGES.md index 2d9dab9..5ea8736 100644 --- a/templates/CHANGES.md +++ b/templates/CHANGES.md @@ -1,8 +1,8 @@ This file describes changes in the {{PackageName}} package. -X.Y (YYYY-MM-DD) +## X.Y.Z (TBD) - Fix bug in ... - ... -0.1 (YYYY-MM-DD) +## 1.0.0 (YYYY-MM-DD) - Initial release From a8915ff5466e9fb725a9548975b08b8a4e989827 Mon Sep 17 00:00:00 2001 From: Daan van Berkel Date: Thu, 1 Oct 2026 17:30:37 +0200 Subject: [PATCH 2/6] Announce the change in own CHANGES.md --- CHANGES.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGES.md b/CHANGES.md index c4e9146..f7b4245 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,7 +1,8 @@ This file describes changes in the PackageMaker package. -## 1.0.2 (TBD) +## 1.0.3 (TBD) - The generated `/doc/title.xml` is ignored + - A `CHANGES.md` is scaffold. ## 1.0.2 (2026-07-13) - Update the GitHub workflows to latest versions From 4ef82e675c911b19762d89dbbba967058bd28aa0 Mon Sep 17 00:00:00 2001 From: Daan van Berkel Date: Thu, 1 Oct 2026 17:35:34 +0200 Subject: [PATCH 3/6] Copy the CHANGES.md template --- gap/generate.g | 1 + 1 file changed, 1 insertion(+) diff --git a/gap/generate.g b/gap/generate.g index daf7177..d3f1a7b 100644 --- a/gap/generate.g +++ b/gap/generate.g @@ -440,6 +440,7 @@ InstallGlobalFunction( PackageWizardGenerate, function( answers ) fi; TranslateTemplate(fail, "README.md", pkginfo ); + TranslateTemplate(fail, "CHANGES.md", pkginfo ); TranslateTemplate(pkginfo.LicenseTemplate, "LICENSE", pkginfo ); TranslateTemplate("PackageInfo.g.in", "PackageInfo.g", pkginfo ); TranslateTemplate(fail, "init.g", pkginfo ); From 0789ffb977bf5544df2bbd736a135bb82c0039d6 Mon Sep 17 00:00:00 2001 From: Daan van Berkel Date: Thu, 1 Oct 2026 17:37:42 +0200 Subject: [PATCH 4/6] Regenerate expected files We should expect a CHANGES.md --- tst/DemoPackage.expected/CHANGES.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 tst/DemoPackage.expected/CHANGES.md diff --git a/tst/DemoPackage.expected/CHANGES.md b/tst/DemoPackage.expected/CHANGES.md new file mode 100644 index 0000000..9308e31 --- /dev/null +++ b/tst/DemoPackage.expected/CHANGES.md @@ -0,0 +1,8 @@ +This file describes changes in the DemoPackage package. + +## X.Y.Z (TBD) + - Fix bug in ... + - ... + +## 1.0.0 (YYYY-MM-DD) + - Initial release From 37f7383f1d0aeba374004a70afb3e36af976a8e0 Mon Sep 17 00:00:00 2001 From: Max Horn Date: Fri, 2 Oct 2026 00:18:06 +0200 Subject: [PATCH 5/6] Apply suggestion from @fingolfin --- CHANGES.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGES.md b/CHANGES.md index 5ea29a7..bb8a5ee 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -3,7 +3,7 @@ This file describes changes in the PackageMaker package. ## Unreleased - The generated `/doc/title.xml` is ignored - - A `CHANGES.md` is scaffold. + - Add `CHANGES.md` to package scaffold. ## 1.0.2 (2026-07-13) From fef382cc7d13749509855e3feef4aca471c76e84 Mon Sep 17 00:00:00 2001 From: Max Horn Date: Fri, 2 Oct 2026 00:19:03 +0200 Subject: [PATCH 6/6] Apply batched suggestions from code review Co-authored-by: Max Horn --- templates/CHANGES.md | 2 +- tst/DemoPackage.expected/CHANGES.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/templates/CHANGES.md b/templates/CHANGES.md index 5ea8736..d420aa8 100644 --- a/templates/CHANGES.md +++ b/templates/CHANGES.md @@ -1,6 +1,6 @@ This file describes changes in the {{PackageName}} package. -## X.Y.Z (TBD) +## Unreleased - Fix bug in ... - ... diff --git a/tst/DemoPackage.expected/CHANGES.md b/tst/DemoPackage.expected/CHANGES.md index 9308e31..941ec70 100644 --- a/tst/DemoPackage.expected/CHANGES.md +++ b/tst/DemoPackage.expected/CHANGES.md @@ -1,6 +1,6 @@ This file describes changes in the DemoPackage package. -## X.Y.Z (TBD) +## Unreleased - Fix bug in ... - ...