Skip to content

Add CHANGES.md to generated packages #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fingolfin merged 7 commits into from
Oct 1, 2026
Merged

Add CHANGES.md to generated packages #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5e204e3
Have a sensible default as CHANGES.md
dvberkel Oct 1, 2026
a8915ff
Announce the change in own CHANGES.md
dvberkel Oct 1, 2026
4ef82e6
Copy the CHANGES.md template
dvberkel Oct 1, 2026
0789ffb
Regenerate expected files
dvberkel Oct 1, 2026
7075e8a
Merge branch 'master' into add-CHANGES-md-on-package-creation
fingolfin Oct 1, 2026
37f7383
Apply suggestion from @fingolfin
fingolfin Oct 1, 2026
fef382c
Apply batched suggestions from code review
fingolfin Oct 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ This file describes changes in the PackageMaker package.
## Unreleased

- The generated `/doc/title.xml` is ignored
- Add `CHANGES.md` to package scaffold.

## 1.0.2 (2026-07-13)

Expand Down
1 change: 1 addition & 0 deletions gap/generate.g
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 );
Expand Down
4 changes: 2 additions & 2 deletions templates/CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
This file describes changes in the {{PackageName}} package.

X.Y (YYYY-MM-DD)
## Unreleased
- Fix bug in ...
- ...

0.1 (YYYY-MM-DD)
## 1.0.0 (YYYY-MM-DD)
- Initial release
8 changes: 8 additions & 0 deletions tst/DemoPackage.expected/CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
This file describes changes in the DemoPackage package.

## Unreleased
- Fix bug in ...
- ...

## 1.0.0 (YYYY-MM-DD)
- Initial release
Loading