Skip to content

Commit 0e0d88b

Browse files
committed
Dedicated fragment for release notes
Signed-off-by: Thierry Wasylczenko <[email protected]>
1 parent 6305bb9 commit 0e0d88b

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

changelog/fragments/00-template.yaml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,23 @@
22
# release notes and/or the migration guide
33
entries:
44
- description: >
5-
Upgrade OPM version that is used by default in the generated Makefile so `make catalog-build` also works on OSX.
5+
Description is the line that shows up in the CHANGELOG. This
6+
should be formatted as markdown and be on a single line. Using
7+
the YAML string '>' operator means you can write your entry
8+
multiple lines and it will still be parsed as a single line.
9+
10+
If an operator type's plugin is being changed then prefix the description with
11+
"(<operator language>/<plugin version>)", ex. "(go/v2)".
12+
If an operator type's runtime is being changed, use then prefix the description
13+
with "For <operator language>-based operators,", ex. "For Go-based operators".
614
715
# kind is one of:
816
# - addition
917
# - change
1018
# - deprecation
1119
# - removal
1220
# - bugfix
13-
kind: "change"
21+
kind: ""
1422
1523
# Is this a breaking change?
1624
breaking: false
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
entries:
2+
- description: >
3+
Upgrade OPM version that is used by default in the generated Makefile so `make catalog-build` also works on OSX.
4+
5+
kind: "change"
6+
7+
# Is this a breaking change?
8+
breaking: false

0 commit comments

Comments
 (0)