Skip to content

Commit f74a8ff

Browse files
committed
Adjust heading levels in release notes.
1 parent 8280e9c commit f74a8ff

5 files changed

+15
-10
lines changed

templates/issue-template--release--bug-fix--security.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Release scheduled for [Month] DD, 20xx 10am - 4pm PT
2323
- [ ] Include a short, descriptive summary of the release, for example:
2424
* "Security release for Backdrop CMS. This release fixes 1 security vulnerability:"
2525
* Include a list of SA's for commits to this release
26-
- [ ] Include a section heading `**Notes for updating**`
26+
- [ ] Include a section heading `## Notes for updating*`
2727
- [ ] Note if any changes were made to files outside the `core` directory, for example:
2828
* ``- No changes have been made to the `.htaccess`, `robots.txt` or default `settings.php` files in this release. Updating customized versions of those files is not necessary.``
2929
* See [this example](https://github.com/backdrop/backdrop/releases/tag/1.18.0) for updates to `.htaccess`
@@ -33,11 +33,12 @@ Release scheduled for [Month] DD, 20xx 10am - 4pm PT
3333
* or `**It will be necessary to run the update script** (located at /core/update.php) for this release.`
3434
* Note: you can use this command to see if any install files were changed:
3535
`ls -1 core/modules/*/*.install | while read filename; do echo "$(git log -1 --pretty="format:%ad %f" --date=format:"%F %R" -- $filename)" $filename; done|sort`
36-
- [ ] Include a section heading `**Changes since version 1.xx.x** are listed below.`
36+
- [ ] Include a section heading `## Changes since version 1.xx.x are listed below.`
3737
* Navigate to [Actions](https://github.com/backdrop/backdrop-issues/actions)
3838
* Select the most recent time "Release Notes Generator" has been run.
3939
* Download the `release-notes` artifact attached to the generator.
4040
* Unzip the file, and copy/pate contents into release notes draft.
41+
- Move the headings to H3, add another `#` before the `##` to get `###`.
4142
* Remove any square brackets in the titles, and move those issues to their own section.
4243
- [ ] Draft Security Advisories (assign to stpaultim / klonos / jenlampton herbdool / quicksketch)
4344

templates/issue-template--release--bug-fix.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Release scheduled for [Month] DD, 20xx 10am - 4pm PT
2222
- [ ] Draft Release notes (assign to jenlampton / herbdool / quicksketch)
2323
- [ ] Include a short, descriptive summary of the release, for example:
2424
* "Maintenance release for Backdrop CMS. This update contains bug fixes and usability improvements only."
25-
- [ ] Include a section heading `**Notes for updating**`
25+
- [ ] Include a section heading `## Notes for updating*`
2626
- [ ] Note if any changes were made to files outside the `core` directory, for example:
2727
* ``- No changes have been made to the `.htaccess`, `robots.txt` or default `settings.php` files in this release. Updating customized versions of those files is not necessary.``
2828
* See [this example](https://github.com/backdrop/backdrop/releases/tag/1.18.0) for updates to `.htaccess`
@@ -32,11 +32,12 @@ Release scheduled for [Month] DD, 20xx 10am - 4pm PT
3232
* or `**It will be necessary to run the update script** (located at /core/update.php) for this release.`
3333
* Note: you can use this command to see if any install files were changed:
3434
`ls -1 core/modules/*/*.install | while read filename; do echo "$(git log -1 --pretty="format:%ad %f" --date=format:"%F %R" -- $filename)" $filename; done|sort`
35-
- [ ] Include a section heading `**Changes since version 1.xx.x** are listed below.`
35+
- [ ] Include a section heading `## Changes since version 1.xx.x are listed below.`
3636
* Navigate to [Actions](https://github.com/backdrop/backdrop-issues/actions)
3737
* Select the most recent time "Release Notes Generator" has been run.
3838
* Download the `release-notes` artifact attached to the generator.
3939
* Unzip the file, and copy/pate contents into release notes draft.
40+
- Move the headings to H3, add another `#` before the `##` to get `###`.
4041
* Remove any square brackets in the titles, and move those issues to their own section.
4142

4243
## Release tasks

templates/issue-template--release--major.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Steps to create a MAJOR release
1717
- [ ] Draft Release notes (assign to jenlampton / herbdool / quicksketch)
1818
- [ ] Include a short, descriptive summary of the release, for example:
1919
* This is the preview release of Backdrop 1.16.0. Please use this version if you would like to help us test the features in the new version of Backdrop prior to the official release on January/May/September 15th, 20xx.
20-
- [ ] Include a section heading `**Notes for updating**`
20+
- [ ] Include a section heading `## Notes for updating*`
2121
- [ ] Note if any changes were made to files outside the `core` directory, for example:
2222
* ``- No changes have been made to the `.htaccess`, `robots.txt` or default `settings.php` files in this release. Updating customized versions of those files is not necessary.``
2323
* See [this example](https://github.com/backdrop/backdrop/releases/tag/1.18.0) for updates to `.htaccess`
@@ -27,11 +27,12 @@ Steps to create a MAJOR release
2727
* or `**It will be necessary to run the update script** (located at /core/update.php) for this release.`
2828
* Note: you can use this command to see if any install files were changed:
2929
`ls -1 core/modules/*/*.install | while read filename; do echo "$(git log -1 --pretty="format:%ad %f" --date=format:"%F %R" -- $filename)" $filename; done|sort`
30-
- [ ] Include a section heading `**Changes since version 1.xx.x** are listed below.`
30+
- [ ] Include a section heading `## Changes since version 1.xx.x are listed below.`
3131
* navigate to [Actions](https://github.com/backdrop/backdrop-issues/actions)
3232
* Select the most recent time "Release Notes Generator" has been run.
3333
* Download the `release-notes` artifact attached to the generator.
3434
* Unzip the file, and copy/pate contents into release notes draft.
35+
- Move the headings to H3, add another `#` before the `##` to get `###`.
3536
* Re-word issue titles to indicate that the problems have been fixed.
3637
- [ ] Draft blog post (assign to tomgrandy / klonos / jenlampton / quicksketch)
3738
- [ ] Draft a newsletter via MailChimp (assign to facetinteractive / tomgrandy / jenlampton)

templates/issue-template--release--minor-preview.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Scheduled for January/May/September 1st, 20xx 10am - 4pm PT
2222
- [ ] Draft Release notes (assign to jenlampton / herbdool / quicksketch)
2323
- [ ] Include a short, descriptive summary of the release, for example:
2424
* This is the preview release of Backdrop 1.16.0. Please use this version if you would like to help us test the features in the new version of Backdrop prior to the official release on January/May/September 15th, 20xx.
25-
- [ ] Include a section heading `**Notes for updating**`
25+
- [ ] Include a section heading `## Notes for updating*`
2626
- [ ] Note if any changes were made to files outside the `core` directory, for example:
2727
* ``- No changes have been made to the `.htaccess`, `robots.txt` or default `settings.php` files in this release. Updating customized versions of those files is not necessary.``
2828
* See [this example](https://github.com/backdrop/backdrop/releases/tag/1.18.0) for updates to `.htaccess`
@@ -32,11 +32,12 @@ Scheduled for January/May/September 1st, 20xx 10am - 4pm PT
3232
* or `**It will be necessary to run the update script** (located at /core/update.php) for this release.`
3333
* Note: you can use this command to see if any install files were changed:
3434
`ls -1 core/modules/*/*.install | while read filename; do echo "$(git log -1 --pretty="format:%ad %f" --date=format:"%F %R" -- $filename)" $filename; done|sort`
35-
- [ ] Include a section heading `**Changes since version 1.xx.x** are listed below.`
35+
- [ ] Include a section heading `## Changes since version 1.xx.x are listed below.`
3636
* navigate to [Actions](https://github.com/backdrop/backdrop-issues/actions)
3737
* Select the most recent time "Release Notes Generator" has been run.
3838
* Download the `release-notes` artifact attached to the generator.
3939
* Unzip the file, and copy/pate contents into release notes draft.
40+
- Move the headings to H3, add another `#` before the `##` to get `###`.
4041
* Re-word issue titles to indicate that the problems have been fixed.
4142

4243
## Pre-release Publicity + documentation tasks

templates/issue-template--release--minor.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,22 @@ Scheduled for January/September/May 15, 20xx 10am - 4pm PT
2323
- [ ] Copy Preview release release notes, update as follows
2424
- [ ] Include a short, descriptive summary of the release, for example:
2525
* The Backdrop community is proud to release version 1.xx of Backdrop CMS, following our 4-month release cycle.
26-
- [ ] Include a section heading `**Notes for updating**`
26+
- [ ] Include a section heading `## Notes for updating*`
2727
- [ ] Note if any changes were made to files outside the `core` directory, for example:
2828
* ``- No changes have been made to the `.htaccess`, `robots.txt` or default `settings.php` files in this release. Updating customized versions of those files is not necessary.``
2929
* See [this example](https://github.com/backdrop/backdrop/releases/tag/1.18.0) for updates to `.htaccess`
3030
* See [this example](https://github.com/backdrop/backdrop/releases/tag/1.16.0) or [this example](https://github.com/backdrop/backdrop/releases/tag/1.14.0) for updates to `settings.php`
3131
- [ ] Note if updates (update.php) needs to be run, for example:
3232
* Use the text `The database update script does **not** need to be run.`
3333
* or `**It will be necessary to run the update script** (located at /core/update.php) for this release.`
34-
- [ ] Include a section heading `**Changes since version 1.xx.x** are listed below.`
34+
- [ ] Include a section heading `## Changes since version 1.xx.x are listed below.`
3535
* Note: you can use this command to see if any install files were changed:
3636
`ls -1 core/modules/*/*.install | while read filename; do echo "$(git log -1 --pretty="format:%ad %f" --date=format:"%F %R" -- $filename)" $filename; done|sort`
3737
* Navigate to [Actions](https://github.com/backdrop/backdrop-issues/actions)
3838
* Select the most recent time "Release Notes Generator" has been run.
3939
* Download the `release-notes` artifact attached to the generator.
4040
* Unzip the file, and copy/pate contents into release notes draft.
41+
- Move the headings to H3, add another `#` before the `##` to get `###`.
4142
* Re-word issue titles to indicate that the problems have been fixed.
4243
* Note: This list can also be copied from the list on the preview release, but review closed issuses in the milestone
4344
- [ ] Verify the list above matches all changes since the most recent bug-fix release

0 commit comments

Comments
 (0)