Commit 656b7b319b7f4e9c39a877e74c1440f9d4dbf6cf
1 parent
80c43b60
Discontinue ChangeLog; update release notes as you go
Showing
3 changed files
with
14 additions
and
7 deletions
ChangeLog
| 1 | -2025-02-15 Jay Berkenbilt <ejb@ql.org> | |
| 1 | +2025-02-19 Jay Berkenbilt <ejb@ql.org> | |
| 2 | 2 | |
| 3 | - * Disable PointerHolder by default. | |
| 3 | + * END USE OF ChangeLog. From this point forward, please consult | |
| 4 | + the release notes for important changes and version control | |
| 5 | + history for detailed changes. | |
| 4 | 6 | |
| 5 | 7 | 2025-02-15 Jay Berkenbilt <ejb@ql.org> |
| 6 | 8 | ... | ... |
README-maintainer.md
| ... | ... | @@ -23,6 +23,11 @@ |
| 23 | 23 | |
| 24 | 24 | ## ROUTINE DEVELOPMENT |
| 25 | 25 | |
| 26 | +**When making changes that users need to know about, update the release notes | |
| 27 | +(manual/release-notes.rst) as you go.** Major changes to the internal API can also be mentioned in | |
| 28 | +the release notes in a section called "Internal Changes" or similar. This removes ChangeLog as a | |
| 29 | +separate mechanism for tracking changes. | |
| 30 | + | |
| 26 | 31 | **Remember to check pull requests as well as issues in github.** |
| 27 | 32 | |
| 28 | 33 | Include `-DCMAKE_EXPORT_COMPILE_COMMANDS=ON` with cmake if using emacs lsp mode. |
| ... | ... | @@ -536,12 +541,10 @@ When done, the following should happen: |
| 536 | 541 | `make_dist` verifies this consistency, and CI fails if they are |
| 537 | 542 | inconsistent. |
| 538 | 543 | |
| 539 | -* Update release notes in manual. Look at diffs and ChangeLog. | |
| 544 | +* Update release notes in manual. Review version control history. | |
| 540 | 545 | Update release date in `manual/release-notes.rst`. Change "not yet |
| 541 | 546 | released" to an actual date for the release. |
| 542 | 547 | |
| 543 | -* Add a release entry to ChangeLog: "x.y.z: release" | |
| 544 | - | |
| 545 | 548 | * Commit changes with title "Prepare x.y.z release" |
| 546 | 549 | |
| 547 | 550 | * Performance test is included with binary compatibility steps. Even | ... | ... |
manual/release-notes.rst
| ... | ... | @@ -3,8 +3,10 @@ |
| 3 | 3 | Release Notes |
| 4 | 4 | ============= |
| 5 | 5 | |
| 6 | -For a detailed list of changes, please see the file | |
| 7 | -:file:`ChangeLog` in the source distribution. | |
| 6 | +This is a curated list of user-facing and developer-facing changes. | |
| 7 | +Prior to version 12, file :file:`ChangeLog` contained more detail. | |
| 8 | +From version 12 onward, please consult version control history for | |
| 9 | +more detail. | |
| 8 | 10 | |
| 9 | 11 | .. x.y.z: not yet released |
| 10 | 12 | ... | ... |