Skip to content

Commit 3c92948

Browse files
authored
Merge pull request #16 from akhundMurad/fix/changelog-job-md
chore(ci): simplify changelog PR workflow
2 parents f9bac77 + 8785bb4 commit 3c92948

2 files changed

Lines changed: 75 additions & 18 deletions

File tree

.github/workflows/publish.yaml

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ jobs:
8484
- name: Checkout
8585
uses: actions/checkout@v4
8686
with:
87+
ref: main
8788
fetch-depth: 0
8889
token: ${{ secrets.GITHUB_TOKEN }}
8990

@@ -96,33 +97,17 @@ jobs:
9697
- name: Generate release notes
9798
run: git cliff --latest --strip header -o RELEASE_NOTES.md
9899

99-
- name: Commit changelog to branch
100-
run: |
101-
git config user.name "github-actions[bot]"
102-
git config user.email "github-actions[bot]@users.noreply.github.com"
103-
104-
BRANCH="changelog/${{ github.ref_name }}-${{ github.run_id }}"
105-
git checkout -b "$BRANCH"
106-
107-
git add CHANGELOG.md
108-
if git diff --staged --quiet; then
109-
echo "No changelog changes; skipping commit + PR."
110-
exit 0
111-
fi
112-
113-
git commit -m "chore: update changelog for ${{ github.ref_name }}"
114-
git push --force-with-lease origin "$BRANCH"
115-
116100
- name: Create pull request for changelog
117101
uses: peter-evans/create-pull-request@v6
118102
with:
119103
token: ${{ secrets.GITHUB_TOKEN }}
120104
base: main
121-
branch: changelog/${{ github.ref_name }}-${{ github.run_id }}
105+
branch: changelog/${{ github.ref_name }}
122106
title: "chore: update changelog for ${{ github.ref_name }}"
123107
body: |
124108
Automated changelog update for `${{ github.ref_name }}`.
125109
commit-message: "chore: update changelog for ${{ github.ref_name }}"
110+
add-paths: CHANGELOG.md
126111

127112
- name: Upload release notes
128113
uses: actions/upload-artifact@v4

CHANGELOG.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,75 @@ All notable changes to this project will be documented in this file.
44

55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [0.0.5] - 2026-01-27
9+
10+
### Added
11+
12+
- **cli:** Add `check` command to evaluate rules against saved snapshots
13+
- **cli:** Document new `pacta check` command and two-step snapshot workflow
14+
15+
### Changed
16+
17+
- Format argparse argument and remove unused import
18+
19+
### Documentation
20+
21+
- Add new example docs pages and example projects (layered, hexagonal, legacy migration)
22+
- Update CLI and examples for snapshot save/check workflow
23+
24+
### Fixed
25+
26+
- **check:** Update existing snapshot object in-place and save optional extra ref
27+
- **ci:** Use --force-with-lease when pushing changelog updates
28+
29+
### Testing
30+
31+
- **cli:** Reformat assertion for save refs call args
32+
33+
## [0.0.4] - 2026-01-26
34+
35+
### Documentation
36+
37+
- Refresh README and getting started with architecture snapshot/history narrative
38+
39+
### Miscellaneous
40+
41+
- **ci:** Create PR for changelog updates instead of pushing to main
42+
43+
## [0.0.3] - 2026-01-25
44+
45+
### Added
46+
47+
- **cli:** Show human-readable violation explanations in text output
48+
- **cli:** Add history commands and content-addressed snapshot store
49+
- **cli:** Add `history trends` with ASCII charts and optional matplotlib export
50+
- **docs:** Document history trends command and add chart example
51+
- **model:** Add optional layer name field and load from spec
52+
53+
### Documentation
54+
55+
- **contributing:** Expand contributing guide with project structure and dev workflow
56+
- **readme:** Reposition as architecture governance tool and add demo gif
57+
- Add changelog and expand MkDocs documentation
58+
59+
### Miscellaneous
60+
61+
- **license:** Switch to Apache-2.0 and bump version to 0.0.2
62+
- Apply formatting and typing tweaks in history output and tests
63+
- **cli:** Remove redundant module docstrings and __future__ imports from chart modules
64+
- **dev:** Add pytest-cov to dev dependencies
65+
66+
## [0.0.2] - 2026-01-23
67+
68+
### Miscellaneous
69+
70+
- **license:** Switch to Apache-2.0 and bump version to 0.0.2
71+
72+
## [0.0.1] - 2026-01-23
73+
74+
[0.0.5]: https://github.com/akhundMurad/pacta/compare/v0.0.4...v0.0.5
75+
[0.0.4]: https://github.com/akhundMurad/pacta/compare/v0.0.3...v0.0.4
76+
[0.0.3]: https://github.com/akhundMurad/pacta/compare/v0.0.2...v0.0.3
77+
[0.0.2]: https://github.com/akhundMurad/pacta/compare/v0.0.1...v0.0.2
78+

0 commit comments

Comments
 (0)