Skip to content

Commit e5cefa1

Browse files
committed
Add cookiecutter sections to RELEASE_NOTES.md
This makes it easier for users to know which changes are code changes and which are cookiecutter template changes. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent c1fef2f commit e5cefa1

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

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)