Ensure ChangeLog updated with every checkin
Bug #1185222 reported by
Chris Hillery
This bug affects 1 person
| Affects | Status | Importance | Assigned to | Milestone | |
|---|---|---|---|---|---|
| Zorba |
New
|
Medium
|
Chris Hillery | ||
Bug Description
We need an RQ test which verifies that every commit has a corresponding ChangeLog entry, or at a minimum someone actively says "this change does not require a ChangeLog entry".
Ideally this would be done in a way that prevents the frequent text conflicts that arise in the ChangeLog file.
Revision history for this message
| Chris Hillery (ceejatec) wrote | #1 |
| Changed in zorba: | |
| assignee: | nobody → Chris Hillery (ceejatec) |
| milestone: | none → 3.0 |
| importance: | Undecided → Medium |
| Changed in zorba: | |
| milestone: | 3.0 → 3.1 |
To post a comment you must log in.
One approach I considered: have a Changelog.d subdirectory where each commit can add a new file with the ChangeLog line. Add a check on the RQ that the commit adds a file to this directory. Allow a file to contain "no-op" contents. At the end of a release cycle, or every so often, collect all those entries via a script into the real ChangeLog, and clean out the directory.
Ideally each file should have a consistent format with one of a few possible categories of change: Fix <bug#>, Added new feature, etc. RQ test should ensure added file has proper form.