From 85ec799ff1c45f716d0e6f948525964864cea630 Mon Sep 17 00:00:00 2001 From: Paul Tsouchlos Date: Fri, 1 Nov 2024 11:54:37 -0400 Subject: [PATCH] chore: add release checklist doc --- docs/release-checklist.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 docs/release-checklist.md diff --git a/docs/release-checklist.md b/docs/release-checklist.md new file mode 100644 index 0000000..fa9d5fc --- /dev/null +++ b/docs/release-checklist.md @@ -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.