Skip to content

Commit

Permalink
Dedicated fragment for release notes
Browse files Browse the repository at this point in the history
Signed-off-by: Thierry Wasylczenko <[email protected]>
  • Loading branch information
twasyl committed Sep 3, 2021
1 parent 487af17 commit 55d86cb
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
12 changes: 10 additions & 2 deletions changelog/fragments/00-template.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,23 @@
# release notes and/or the migration guide
entries:
- description: >
Upgrade OPM version that is used by default in the generated Makefile so `make catalog-build` also works on OSX.
Description is the line that shows up in the CHANGELOG. This
should be formatted as markdown and be on a single line. Using
the YAML string '>' operator means you can write your entry
multiple lines and it will still be parsed as a single line.
If an operator type's plugin is being changed then prefix the description with
"(<operator language>/<plugin version>)", ex. "(go/v2)".
If an operator type's runtime is being changed, use then prefix the description
with "For <operator language>-based operators,", ex. "For Go-based operators".
# kind is one of:
# - addition
# - change
# - deprecation
# - removal
# - bugfix
kind: "change"
kind: ""
# Is this a breaking change?
breaking: false
Expand Down
8 changes: 8 additions & 0 deletions changelog/fragments/01-upgrade-opm-version.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
entries:
- description: >
Upgrade OPM version that is used by default in the generated Makefile so `make catalog-build` also works on OSX.
kind: "change"
# Is this a breaking change?
breaking: false

0 comments on commit 55d86cb

Please sign in to comment.