Skip to content

Commit bf90349

Browse files
authored
docs: Add body to Outputs (#1129)
Add output for body: Benefits: - Automatically includes all commit messages formatted by release-please - Consistent with GitHub Release notes - No need to manually extract or format changelog content - Perfect for CI/CD integrations that need release notes close #1128 Signed-off-by: Kevin A. Hernández Rostrán <kevinah95@gmail.com>
1 parent 1cfb21c commit bf90349

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,7 @@ If you have a root component (path is `.` or unset), then the action will also o
190190
| `minor` | Number representing minor semver value |
191191
| `patch` | Number representing patch semver value |
192192
| `sha` | SHA that a GitHub release was tagged at |
193+
| `body` | Release notes for the current version extracted from the CHANGELOG.md |
193194

194195
### Path outputs
195196

@@ -209,6 +210,7 @@ This prefix allows you to distinguish values for different releases.
209210
| `<path>--minor` | Number representing minor semver value |
210211
| `<path>--patch` | Number representing patch semver value |
211212
| `<path>--sha` | sha that a GitHub release was tagged at |
213+
| `<path>--body` | Release notes for the current version extracted from the CHANGELOG.md |
212214

213215
If the path contains `/` you can access the outputs by using javascript like property access `steps.release.outputs[<path>--...]`
214216
e.g.:

0 commit comments

Comments
 (0)