;doc: move the project changelog to doc/, for easy consistent paths
Leave a top-level CHANGES placeholder for discoverability.
This commit is contained in:
parent
d6ddacbec4
commit
cef35b97bd
2
CHANGES
Normal file
2
CHANGES
Normal file
@ -0,0 +1,2 @@
|
||||
General project changes are in doc/CHANGES.md.
|
||||
Package-specific changes are in hledger*/CHANGES.md.
|
||||
2
Shake.hs
2
Shake.hs
@ -195,7 +195,7 @@ main = do
|
||||
pkgdirs = packages
|
||||
pkgandprojdirs = "" : pkgdirs
|
||||
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]
|
||||
packagemandatem4s = [p </> ".date.m4" | p <- packages]
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ Before release, and preferably daily/weekly as well:
|
||||
- `./Shake changelogs`
|
||||
- edit the new changelog items
|
||||
- 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
|
||||
- paste section headings from top comment if needed
|
||||
- process new items, from top-most section heading upward
|
||||
|
||||
@ -100,7 +100,7 @@ It should be improved each time it is used.
|
||||
- embedded asciinema demos (hledger/embeddedfiles/*.cast)
|
||||
- shell completions (hledger/shell-completion/hledger-completion.bash)
|
||||
`just completions`, commit any changes
|
||||
- changelogs x 5 (**/CHANGES.md)
|
||||
- changelogs x 5 (*/CHANGES.md)
|
||||
`just changelogs [-c]`
|
||||
add notable changes from site, finance repos to project changelog (major release only)
|
||||
add issue links with `md-issue-refs`, uniquify
|
||||
|
||||
Loading…
Reference in New Issue
Block a user