elagil/modern-cv
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore: add release checklist doc

Browse Source
This commit is contained in:
Paul Tsouchlos
2024-11-01 11:54:37 -04:00
parent cf472b703d
commit 85ec799ff1
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/release-checklist.md Normal file
View File

@@ -0,0 +1,13 @@
# Release Checklist
This document outlines the steps required to prepare a new release of `modern-cv`.
Steps:
1. Create a new release branch with the format `release/x.y.z`.
2. Update the version in the `typst.toml`.
3. Update examples in the [README.md](../README.md) to reflect the new version.
4. Update templates to import the correct version.
5. Do a final compilation/export check of all the templates.
6. Ensure that tests pass.
7. Ensure that the documentation manual builds.