Currently the changelog is created manually and is published at different locations (at least GitHub Release page and Discord channel).
This process should be unified and simplified.
- Create a
CHANGELOG.md in the root of this project.
- Define a fixed structure for every release:
# swift version X.X.X (<DATE>)
## What's changed
<PLACEHOLDER>
### Features
<LIST OF NEW FEATURES>
### Fixes
<LIST OF FIXES>
## Contributors
<LIST OF CONTRIBUTORS>
- With every PR populate the changelog
- Display the CHANGELOG.md within the swift application (possibly using a
QTextEdit)
- Use the
CHANGELOG.md for the Discord notification and GitHub Release information
- Add a link to the latest
CHANGELOG.md on the documentation homepage
Currently the changelog is created manually and is published at different locations (at least GitHub Release page and Discord channel).
This process should be unified and simplified.
CHANGELOG.mdin the root of this project.QTextEdit)CHANGELOG.mdfor the Discord notification and GitHub Release informationCHANGELOG.mdon the documentation homepage