Skip to content

Commit 3f22666

Browse files
committed
Add version and changelog update policy
Add a new policy that triggers when files in src/ are modified, requiring evaluation of whether version bumps and changelog entries are needed. The policy enforces explicit action - either updating pyproject.toml and CHANGELOG.md, or justifying why no update is needed.
1 parent 5ffbf90 commit 3f22666

1 file changed

Lines changed: 29 additions & 1 deletion

File tree

.deepwork.policy.yml

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,32 @@
4040
3. Run `deepwork install --platform claude` to sync changes
4141
4. Verify the changes propagated correctly
4242
43-
See CLAUDE.md section "CRITICAL: Editing Standard Jobs" for details.
43+
See CLAUDE.md section "CRITICAL: Editing Standard Jobs" for details.
44+
45+
- name: "Version and Changelog Update"
46+
trigger: "src/**/*"
47+
safety:
48+
- "pyproject.toml"
49+
- "CHANGELOG.md"
50+
instructions: |
51+
Source code in src/ has been modified. **You MUST evaluate whether version and changelog updates are needed.**
52+
53+
**Evaluate the changes:**
54+
1. Is this a bug fix, new feature, breaking change, or internal refactor?
55+
2. Does this change affect the public API or user-facing behavior?
56+
3. Would users need to know about this change when upgrading?
57+
58+
**If version update is needed:**
59+
1. Update the `version` field in `pyproject.toml` following semantic versioning:
60+
- PATCH (0.1.x): Bug fixes, minor internal changes
61+
- MINOR (0.x.0): New features, non-breaking changes
62+
- MAJOR (x.0.0): Breaking changes
63+
2. Add an entry to `CHANGELOG.md` under an appropriate version header:
64+
- Use categories: Added, Changed, Fixed, Removed, Deprecated, Security
65+
- Include a clear, user-facing description of what changed
66+
- Follow the Keep a Changelog format
67+
68+
**If NO version update is needed** (e.g., tests only, comments, internal refactoring with no behavior change):
69+
- Explicitly state why no version bump is required
70+
71+
**This policy requires explicit action** - either update both files or justify why no update is needed.

0 commit comments

Comments
 (0)