Skip to content

Commit a85beb6

Browse files
authored
Release v1.7.2 (#48)
1 parent 9949074 commit a85beb6

3 files changed

Lines changed: 65 additions & 2 deletions

File tree

.agents/skills/release/SKILL.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
name: release
3+
description: Prepare a new MkDocs-NG release by updating the version, release notes date, and running pre-release checks. Use when the user asks to start or prepare a release, cut a release, or update version numbers.
4+
---
5+
6+
# Release Preparation
7+
8+
## Overview
9+
10+
Prepare the repository for a new MkDocs-NG release by updating the version string and release notes date.
11+
12+
## Workflow
13+
14+
1. **Determine the version.** Ask the user for the target version (e.g., `1.7.2`), or infer it from the `(Unreleased)` section in `docs/about/release-notes.md`.
15+
16+
2. **Update `mkdocs/__init__.py`.** Change `__version__` to the new version:
17+
18+
```diff
19+
-__version__ = "1.7.1"
20+
+__version__ = "1.7.2"
21+
```
22+
23+
3. **Update `docs/about/release-notes.md`.** Replace `(Unreleased)` with today's date in `YYYY-MM-DD` format for the target version heading:
24+
25+
```diff
26+
-## Version 1.7.2 (Unreleased)
27+
+## Version 1.7.2 (2026-04-27)
28+
```
29+
30+
Use the current date. You can obtain it with:
31+
32+
```bash
33+
date +%Y-%m-%d
34+
```
35+
36+
4. **Run pre-commit checks** to ensure everything passes:
37+
38+
```bash
39+
uvx prek run -a
40+
```
41+
42+
If checks fail, fix the reported issues and rerun until clean.
43+
44+
5. **Verify the changes** are correct:
45+
46+
```bash
47+
git diff
48+
```
49+
50+
## Files Modified
51+
52+
| File | Change |
53+
|------|--------|
54+
| `mkdocs/__init__.py` | `__version__` string |
55+
| `docs/about/release-notes.md` | Date in the target version heading |
56+
57+
No other files carry a hard-coded version. `pyproject.toml` reads the version dynamically from `mkdocs/__init__.py`.
58+
59+
## Notes
60+
61+
- Do not commit the changes automatically; let the user decide when to commit.
62+
- The `pyproject.toml` uses `dynamic = ["version"]` with `tool.hatch.version.path = "mkdocs/__init__.py"`, so only `__init__.py` needs updating.
63+
- After completing the release preparation, the user should create a git tag (e.g., `git tag 1.7.2`) and push it to trigger the PyPI publish workflow.

docs/about/release-notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The current members of the MkDocs-NG team.
2323

2424
* [@shenxianpeng](https://github.com/shenxianpeng)
2525

26-
## Version 1.7.2 (Unreleased)
26+
## Version 1.7.2 (2026-04-27)
2727

2828
### Fixed
2929

mkdocs/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33

44
# For acceptable version formats, see https://www.python.org/dev/peps/pep-0440/
5-
__version__ = "1.7.1"
5+
__version__ = "1.7.2"

0 commit comments

Comments
 (0)