diff --git a/docs/release.md b/docs/release.md index baceab2..b3b0772 100644 --- a/docs/release.md +++ b/docs/release.md @@ -23,6 +23,7 @@ That's the only setup required. No secrets, no tokens, no third-party services. ## The release checklist +### Update version number Before tagging a release, update the version number in two places: **`mdcms.py`** — find this line near the top and bump it: @@ -37,20 +38,34 @@ version = "0.3.1" > **Site format version** — the markers in `app/config.yml` and `app/index.html` (`# mdcms v0.3`) are separate from the CLI version. Only update them if the site file format has a breaking change that requires users to re-download the template. Most releases do not touch these. +#### Commit locally Commit the version bump: ```bash git add mdcms.py pyproject.toml git commit -m "Bump version to 0.3.1" git push origin main ``` +#### Commit on the web +Save each file with a version bump notice: `"Bump version to 0.3.1"`. -## Tagging the release +### Tagging the release +#### Locally Push a version tag to trigger the workflow: ```bash git tag v0.3.1 git push origin v0.3.1 ``` +#### On the web + +1. Go to your repository → Releases (right sidebar) +1. Click Draft a new release +1. Click Choose a tag → type v0.3.0 → click Create new tag: v0.3.0 on publish +1. Leave the target branch as main +1. Click Generate release notes +1. Click Publish release + +#### Common The tag must start with `v`. The workflow triggers immediately.