kbenestad/mdcms
1
0
Fork 0
mirror of https://github.com/kbenestad/mdcms.git synced 2026-06-18 15:24:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update release checklist with version bump instructions

Browse source 
Added instructions for updating the version number and committing changes before tagging a release.
This commit is contained in:
Kristian Benestad 2026-05-08 23:45:24 +07:00 committed by GitHub
parent a3e328e1b8
commit 8f8e6b7734
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 16 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docs/release.md
View file

@ -23,6 +23,7 @@ That's the only setup required. No secrets, no tokens, no third-party services.
## The release checklist ## The release checklist
### Update version number
Before tagging a release, update the version number in two places: Before tagging a release, update the version number in two places:
**`mdcms.py`** — find this line near the top and bump it: **`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. > **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: Commit the version bump:
```bash ```bash
git add mdcms.py pyproject.toml git add mdcms.py pyproject.toml
git commit -m "Bump version to 0.3.1" git commit -m "Bump version to 0.3.1"
git push origin main 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: Push a version tag to trigger the workflow:
```bash ```bash
git tag v0.3.1 git tag v0.3.1
git push origin 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. The tag must start with `v`. The workflow triggers immediately.