Skip to content

Commit 1b202c5

Browse files
committed
updated release workflow
1 parent d242b95 commit 1b202c5

2 files changed

Lines changed: 10 additions & 1 deletion

File tree

.github/RELEASE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,19 @@
22

33
## Creating a Release
44

5+
1. Update `CHANGELOG.md`:
6+
- Rename `[Unreleased]` to `[X.Y.Z] - YYYY-MM-DD`
7+
- Add new empty `[Unreleased]` section with subheaders
8+
- Update comparison links at the bottom
9+
10+
2. Bump version and push:
511
```bash
612
python scripts/bump_version.py patch # or: minor, major
713
git push && git push --tags
814
```
915

16+
The script automatically stages `CHANGELOG.md` along with `pyproject.toml`.
17+
1018
Automation handles the rest: https://github.com/parameterlab/maseval/actions
1119

1220
---

scripts/bump_version.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,8 @@ def main():
7171

7272
# Commit and tag
7373
print("\nCreating git commit and tag...")
74-
subprocess.run(["git", "add", str(pyproject_path)], check=True)
74+
changelog_path = repo_root / "CHANGELOG.md"
75+
subprocess.run(["git", "add", str(pyproject_path), str(changelog_path)], check=True)
7576
subprocess.run(["git", "commit", "-m", f"Bump version to {new_version}"], check=True)
7677
subprocess.run(["git", "tag", "-s", f"v{new_version}", "-m", f"Release v{new_version}"], check=True)
7778

0 commit comments

Comments
 (0)