Skip to content

Commit 7799c1a

Browse files
authored
Add cookiecutter sections to RELEASE_NOTES.md (frequenz-floss#111)
This makes it easier for users to know which changes are code changes and which are cookiecutter template changes. Also require release notes for changes in cookiecutter templates. The workflow to check for updates to release notes wasn't taking into account changes to cookiecutter templates, which are very important to notify to users.
2 parents fc96c8e + e1e54ea commit 7799c1a

File tree

3 files changed

+19
-3
lines changed

3 files changed

+19
-3
lines changed

.github/RELEASE_NOTES.template.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,22 @@
88

99
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
1010

11+
### Cookiecutter template
12+
13+
<!-- Here upgrade steps for cookiecutter specifically -->
14+
1115
## New Features
1216

1317
<!-- Here goes the main new features and examples or instructions on how to use them -->
1418

19+
### Cookiecutter template
20+
21+
<!-- Here new features for cookiecutter specifically -->
22+
1523
## Bug Fixes
1624

1725
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
26+
27+
### Cookiecutter template
28+
29+
<!-- Here bug fixes for cookiecutter specifically -->

.github/workflows/release-notes-check.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,6 @@ jobs:
2323
uses: brettcannon/check-for-changed-files@4170644959a21843b31f1181f2a1761d65ef4791 # v1.2.0
2424
with:
2525
file-pattern: "RELEASE_NOTES.md"
26-
prereq-pattern: "src/**"
26+
prereq-pattern: "{src,cookiecutter}/**"
2727
skip-label: "cmd:skip-release-notes"
2828
failure-message: "Missing a release notes update. Please add one or apply the ${skip-label} label to the pull request"

RELEASE_NOTES.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
## Upgrading
88

9+
### Cookiecutter template
10+
911
- To make the new workflow to check if release notes were updated you should add the check to the branch protection rules of your repository to require this check to pass. You should also add a new label *"cmd:skip-release-notes"* to be able to override the check. You can use the following script to do it:
1012

1113
```sh
@@ -32,7 +34,7 @@
3234

3335
## New Features
3436

35-
### Cookietutter template
37+
### Cookiecutter template
3638

3739
- Add a new GitHub workflow to check that release notes were updated.
3840

@@ -48,4 +50,6 @@
4850

4951
- The distribution package doesn't include tests and other useless files anymore.
5052

51-
- Cookiecutter: Now the CI workflow will checkout the submodules.
53+
### Cookiecutter template
54+
55+
- Now the CI workflow will checkout the submodules.

0 commit comments

Comments
 (0)