Come together with the global Drupal community in Rotterdam, 28 Sept – 1 Oct 2026. Sessions, contribution, connection, and Early Bird savings until 8 June.There are many issues that would benefit from a change record being created, but the changenotice node creation process is somewhat opaque for many. I suggest adding something to the issue node page to make it easier to create a changenotice from an issue.
Comparing the node/add/changenotice form to an issue, there are several pieces that could be auto-completed:
- Project
- Issues
- Introduced in branch
- Title - start with the issue's title?
- Description - maybe provide a template, as is done for security advisories.
Once some of these were worked out I think there should be a link available on the issue page for quickly & easily creating a change notice, along with a link to a documentation page explaining what change records are and providing best practices on creating them.
| Comment | File | Size | Author |
|---|---|---|---|
| #3 | Screen Shot 2017-08-27 at 4.30.45 PM.png | 14.43 KB | webchick |
Comments
Comment #2
drummChange notices are only in drupal.org customizations.
Comment #3
webchickI went through today to create a change record and was shocked that a link to do so from the issue did not exist. This must be something that Dreditor added.
Anywho. Without that, the process is:
1) Somehow magically know the URL https://www.drupal.org/list-changes/drupal, since it is not linked from absolutely anywhere in the main Drupal.org navigation, AFAIK.
2) Click "Add new change record" from there.
3) Populate it with your issue info.
Since #1 is pretty insurmountable for anyone who isn't the insider-est of Drupal insiders, this seems like something we should address.
As far as a UI, just literally adding an "Add change record" link to this block would work. Extra bonus points if it pre-populates the issue in the form.
Comment #4
xjmThis would be useful because it also helps people understand that they can create a change record. It's something that gets forgotten a lot until the last minute.
Since one issue can have multiple change records, the link could be shown at all times, just as the other two in @webhick's screenshot are.
Comment #5
drummProject pages, like https://www.drupal.org/project/drupal, link to the project’s change records. Buried in the sidebar links, “View change records”. (To make them more visible, maybe link to them automatically from release pages. I think that’s helpful for users looking to figure out an upgrade. I think core does a good job of mentioning change records in places like release notes.)
Now is a good time to revisit #2155653: Use a consistent term for change notification, change notice and change record and make sure we’re using good words.
Comment #6
drummComment #8
drummThe issue sidebar now has a “add change notice” link which pre-fills project & issue.
Comment #10
damienmckennaThat's just awesome, thanks drumm!
Comment #11
webchickWow, that was fast! Thanks! :D
Comment #12
xjmThis is great!
Just a small correction, NBD: The link should say "change record" rather than "change notice" (we standardized on that terminology awhile back).
Comment #13
drummUpdating #2155653: Use a consistent term for change notification, change notice and change record to say that “change record” is what we want.