Skip to content

Commit

Permalink
Add remark about aggregated release notes.
Browse files Browse the repository at this point in the history
  • Loading branch information
Gerrit91 committed Mar 22, 2021
1 parent 20e0170 commit 40ec599
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/release_flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Some further remarks:

- Use semver versions with `v` prefix for your tags
- Name your release after your release tag
- The metal-robot only picks up lines from your release notes that start with `-` or `*` (unordered list items) and carries some over into the aggregated release draft.
- The metal-robot only picks up lines from your release notes that start with `-` or `*` (unordered list items) and appends them to the according section in the aggregated release draft
- A tag created through a Github UI release does not trigger a `push` event . This means, your pipeline will not start to run with the `push` trigger when publishing through the UI.

Instead, use the `published` [release event trigger](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#release) for your actions:
Expand Down

0 comments on commit 40ec599

Please sign in to comment.