Early Bird Registration for DrupalCon Portland 2024 is open! Register by 23:59 PST on 31 March 2024, to get $100 off your ticket.
This is the first time I've done a run of helping with the CHANGELOG.txt/release notes prepping, and it seems like at least one useful modification would be to include issue #s alongside CHANGELOG.txt entries so we can very easily make something that looks like this: https://www.drupal.org/project/drupal/releases/8.2.0-beta2 out of it.
Comment | File | Size | Author |
---|---|---|---|
#7 | 2848192-7.patch | 4 KB | wturrell |
#7 | interdiff-2848192-3-7.txt | 3.23 KB | wturrell |
#3 | 2848192-3.patch | 4.1 KB | webchick |
#2 | 2848192-2.patch | 4.1 KB | webchick |
Comments
Comment #2
webchickFor example. (Only did the first bit to get a taste.)
Comment #3
webchickOops. :)
Comment #4
xjmHm, my preference would be not to do this. It makes the notes harder to read. If we're going to automate things, I'd rather do it the other way around: have people actually tag things for the release notes, add the human-readable summary *handwave* generated into the release notes, and then have it added to the changelog without links/IDs. The release notes are not formatted the way they are because it's desired; they're formatted the way they are because they are auto-generated from the issue tag & a bash script for most releases:.
Comment #5
xjmSo @webchick convinced me this will in fact save a lot of manual work.
Comment #6
xjmMaybe we should put the issue ID at the end in parentheses. That's still parseable, but it puts the emphasis on the human information. Unlike in the git log, the NID is not the most important info.
Comment #7
wturrell CreditAttribution: wturrell as a volunteer commentedRevised patch with names at end in parentheses (and # removed, feels superfluous).
Opinions:
- like having the issue numbers, find bit too distracting at start
- pedantry: many redundant words in descriptions, could write more concisely if desired. (If so, presume best wait for this to be merged given expected git conflicts with 2846830.)
Comment #8
xjm@webchick and I agreed to do this for the 8.4.0 CHANGELOG, but not for 8.3.0. :) Postponing for that reason. Thanks!
Comment #9
xjmWe're incorporating this recommendation in #2895685: Create release notes (a.k.a CHANGELOG) for Drupal 8.4.0-alpha1 and Drupal 8.4.0.