| name | release-helper |
| description | Automates version bumping and documentation synchronization for DP-EVA releases. Invoke when preparing a new release or bumping versions. |
DP-EVA Release Helper
This skill automates the release process by:
- Fetching Changes: Retrieves git commit history since the last version tag.
- Summarizing Updates: Combines git logs with current session changes to generate a release summary.
- Bumping Version: Updates
src/dpeva/__init__.py and README.md metadata.
- Guiding Documentation Updates: Points maintainers to the canonical release-note location in
docs/guides/developer-guide.md.
Usage
1. Prepare Release Information
First, analyze the changes to be included in this release:
- Check git logs since the last tag:
git log --oneline $(git describe --tags --abbrev=0)..HEAD
- Summarize the key changes (Features, Fixes, Refactors, Docs).
2. Execute Release Script
Run the release helper script to bump the version and update files.
To perform a Patch Release (e.g., 0.4.5 -> 0.4.6):
python scripts/release_helper.py patch
To perform a Minor Release (e.g., 0.4.5 -> 0.5.0):
python scripts/release_helper.py minor
3. Update Developer Guide
CRITICAL: You must manually update docs/guides/developer-guide.md after running the script. The script only updates version metadata in src/dpeva/__init__.py and README.md.
Action:
- Open
docs/guides/developer-guide.md.
- Locate the
## 6. 版本修订记录 -> ### 6.2 版本历史 -> #### Current Era (v0.7.x) 章节。
- Insert the new version entry at the TOP of the list (below the header).
- Format the entry as follows:
* **vX.Y.Z** (YYYY-MM-DD):
* **[类型]** 变更描述...
* **[类型]** 变更描述...
- Ensure you follow the "Append-only" policy defined in section 6.1.
Post-Execution Steps
- Verify that
src/dpeva/__init__.py and README.md have the correct new version.
- Verify that
docs/guides/developer-guide.md contains the new version entry and is correctly formatted.
- Commit the changes:
git commit -am "chore: release vX.Y.Z"
- Tag the release:
git tag vX.Y.Z
