slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;doc: move the project changelog to doc/, for easy consistent paths

Browse Source 
Leave a top-level CHANGES placeholder for discoverability.
This commit is contained in:
Simon Michael 2025-10-11 10:04:31 -10:00
parent d6ddacbec4
commit cef35b97bd
5 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES Normal file
View File

@ -0,0 +1,2 @@
General project changes are in doc/CHANGES.md.
Package-specific changes are in hledger*/CHANGES.md.

2
Shake.hs
View File

@ -195,7 +195,7 @@ main = do
pkgdirs = packages pkgdirs = packages
pkgandprojdirs = "" : pkgdirs pkgandprojdirs = "" : pkgdirs
cabalfiles = [p </> p <.> "cabal" | p <- packages] cabalfiles = [p </> p <.> "cabal" | p <- packages]
changelogs = map (</> "CHANGES.md") pkgandprojdirs changelogs = map (</> "CHANGES.md") pkgdirs ++ ["doc/CHANGES.md"]
packagemanversionm4s = [p </> ".version.m4" | p <- packages] packagemanversionm4s = [p </> ".version.m4" | p <- packages]
packagemandatem4s = [p </> ".date.m4" | p <- packages] packagemandatem4s = [p </> ".date.m4" | p <- packages]

2
doc/CHANGELOGS.md
View File

@ -14,7 +14,7 @@ Before release, and preferably daily/weekly as well:
- `./Shake changelogs` - `./Shake changelogs`
- edit the new changelog items - edit the new changelog items
- open the five changelogs - open the five changelogs
- in emacs: `M-x dired-find`, `-name CHANGES.md`, `(`, split into 5 columns, open each one, narrow from last release heading to top - in emacs: `C-x d */CHANGES.md`, `(`, split into 5 columns, open each one, narrow from last release heading to top
- in each changelog - in each changelog
- paste section headings from top comment if needed - paste section headings from top comment if needed
- process new items, from top-most section heading upward - process new items, from top-most section heading upward

0
CHANGES.md → doc/CHANGES.md
View File

2
doc/RELEASING.md
View File

@ -100,7 +100,7 @@ It should be improved each time it is used.
- embedded asciinema demos (hledger/embeddedfiles/*.cast) - embedded asciinema demos (hledger/embeddedfiles/*.cast)
- shell completions (hledger/shell-completion/hledger-completion.bash) - shell completions (hledger/shell-completion/hledger-completion.bash)
`just completions`, commit any changes `just completions`, commit any changes
- changelogs x 5 (**/CHANGES.md) - changelogs x 5 (*/CHANGES.md)
`just changelogs [-c]` `just changelogs [-c]`
add notable changes from site, finance repos to project changelog (major release only) add notable changes from site, finance repos to project changelog (major release only)
add issue links with `md-issue-refs`, uniquify add issue links with `md-issue-refs`, uniquify