Skip to content

Commit 388d3ef

Browse files
chore: Configure release notes (#640)
## Description Updates out `release.yaml` so that it is more in line with other Dibbs projects. [ecr-refiner](https://github.com/CDCgov/dibbs-ecr-refiner/blob/main/.github/release.yml), [ecr-viewer](https://github.com/CDCgov/dibbs-ecr-viewer/blob/main/.github/release.yaml). ## Related Issues n/a ## Additional information This just tells Github what to include/exclude in the autogenerated release notes and where to put them, based on their labels. This will create two sections: "🏕 Features", and "👒 Dependencies". Features include all PRs that do not have the "dependencies", "chore", or "tech debt" labels. Dependencies include all PRs with the "dependencies" label. During the last eng sync we talked a little about [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), which are just a standardized way to include some additional information in your commit string. While it is possible with actions to use conventional commits to drive release note generation, this PR just uses the builtin Github note generation which is driven by labels.
1 parent 2f0b9ca commit 388d3ef

2 files changed

Lines changed: 13 additions & 8 deletions

File tree

.github/release.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
changelog:
2+
categories:
3+
- title: 🏕 Features
4+
labels:
5+
- '*'
6+
exclude:
7+
labels:
8+
- dependencies
9+
- tech debt
10+
- chore
11+
- title: 👒 Dependencies
12+
labels:
13+
- dependencies

.github/release.yml

Lines changed: 0 additions & 8 deletions
This file was deleted.

0 commit comments

Comments
 (0)