From 85ec799ff1c45f716d0e6f948525964864cea630 Mon Sep 17 00:00:00 2001 From: Paul Tsouchlos Date: Fri, 1 Nov 2024 11:54:37 -0400 Subject: [PATCH 1/4] 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. From e1a2395acdfefd5c1eea5f74ace2243d600063ab Mon Sep 17 00:00:00 2001 From: Paul Tsouchlos Date: Fri, 1 Nov 2024 11:55:20 -0400 Subject: [PATCH 2/4] chore: update version in README example Resolves #74 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 39a20de..86b8a03 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ See `typst fonts --help` for more information on configuring fonts for `typst` t Below is a basic example for a simple resume: ```typst -#import "@preview/modern-cv:0.6.0": * +#import "@preview/modern-cv:0.7.0": * #show: resume.with( author: ( From 8d599b3efba55576a913e2b02ddc29e65cb31f09 Mon Sep 17 00:00:00 2001 From: Paul Tsouchlos Date: Fri, 1 Nov 2024 11:55:47 -0400 Subject: [PATCH 3/4] chore: use spaces not tabs --- Justfile | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Justfile b/Justfile index 28e84d2..882c22b 100644 --- a/Justfile +++ b/Justfile @@ -4,19 +4,19 @@ export TYPST_ROOT := root [private] default: - @just --list --unsorted + @just --list --unsorted # generate manual doc: - typst compile docs/manual.typ docs/manual.pdf + typst compile docs/manual.typ docs/manual.pdf # run test suite test *args: - typst-test run {{ args }} + typst-test run {{ args }} # update test cases update *args: - typst-test update {{ args }} + typst-test update {{ args }} # package the library into the specified destination folder package target: From e461be5d1a0b2df852de25e9ea63e5e02b100bcd Mon Sep 17 00:00:00 2001 From: Paul Tsouchlos Date: Fri, 1 Nov 2024 12:06:55 -0400 Subject: [PATCH 4/4] fix: do not use `v{}` tags in release workflow --- .github/workflows/release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 93dbe07..2f1ad46 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -41,7 +41,7 @@ jobs: echo "PKG_NAME=${PKG_PREFIX}" >> "${GITHUB_ENV}" echo "PKG_VERSION=${VERSION}" >> "${GITHUB_ENV}" - if [[ "${GITHUB_REF_NAME}" != "v${VERSION}" ]]; then + if [[ "${GITHUB_REF_NAME}" != "${VERSION}" ]]; then echo "package version ${VERSION} does not match release tag ${GITHUB_REF_NAME}" >&2 exit 1 fi