add changelog template for new verions

and mark unused headers as deprecated
develop
Myk Taylor 2023-08-06 23:02:45 -07:00
parent a7129cad04
commit 488ad0f827
No known key found for this signature in database
2 changed files with 25 additions and 5 deletions

@ -22,6 +22,26 @@ changelog.txt uses a syntax similar to RST, with a few special sequences:
spans multiple lines. Three ``]`` characters indicate the end of such a block. spans multiple lines. Three ``]`` characters indicate the end of such a block.
- ``!`` immediately before a phrase set up to be replaced (see gen_changelog.py) stops that occurrence from being replaced. - ``!`` immediately before a phrase set up to be replaced (see gen_changelog.py) stops that occurrence from being replaced.
Template for new versions:
# Future
## New Features
## Fixes
## Misc Improvements
## Documentation
## API
## Internals
## Lua
## Removed
===end ===end
]]] ]]]
@ -33,7 +53,7 @@ changelog.txt uses a syntax similar to RST, with a few special sequences:
# Future # Future
## New Plugins ## New Features
## Fixes ## Fixes

@ -16,11 +16,11 @@ CHANGELOG_PATHS = (
CHANGELOG_PATHS = (os.path.join(DFHACK_ROOT, p) for p in CHANGELOG_PATHS) CHANGELOG_PATHS = (os.path.join(DFHACK_ROOT, p) for p in CHANGELOG_PATHS)
CHANGELOG_SECTIONS = [ CHANGELOG_SECTIONS = [
'New Plugins', 'New Plugins', # deprecated
'New Scripts', 'New Scripts', # deprecated
'New Tweaks', 'New Tweaks', # deprecated
'New Features', 'New Features',
'New Internal Commands', 'New Internal Commands', # deprecated
'Fixes', 'Fixes',
'Misc Improvements', 'Misc Improvements',
'Removed', 'Removed',