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 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: 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: ( 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.