Skip to content

Commit 3217a25

Browse files
committed
docs: document changelog generation system
1 parent 50e9983 commit 3217a25

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

DEVELOPER.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,12 +101,21 @@ yarn release
101101
```
102102

103103
This will automatically:
104-
- ✅ Bump version in `package.json`, `readme.txt`, `woocommerce-gateway-monei.php`, and `class-woocommerce-gateway-monei.php`
105-
- ✅ Generate changelog from commit history → `readme.txt`
104+
- ✅ Bump version in `package.json`, `readme.txt`, `.readme-template`, `woocommerce-gateway-monei.php`, and `class-woocommerce-gateway-monei.php`
105+
- ✅ Generate changelog from git conventional commits
106+
- ✅ Update `readme.txt` with new changelog entries above manual entries
107+
- ✅ Generate `CHANGELOG.md` with full git history
106108
- ✅ Create git tag (e.g., `6.3.9`)
107109
- ✅ Generate GitHub release notes
108110
- ✅ Push changes and tags to GitHub
109111

112+
**Changelog System:**
113+
- New releases with conventional commits → auto-generated entries at the top
114+
- Historical releases → manual entries preserved below
115+
- `.readme-template` contains `{{__PLUGIN_CHANGELOG__}}` placeholder
116+
- `generate-wp-readme` replaces placeholder with git commit history
117+
- Manual changelog entries remain intact below the auto-generated section
118+
110119
3. **CI/CD takes over**:
111120
- GitHub Actions builds the plugin
112121
- Deploys to WordPress.org

0 commit comments

Comments
 (0)