From 4f8867fa5eec0b3f59ead8f69aeba316c24907b3 Mon Sep 17 00:00:00 2001 From: Nick Cipollo Date: Thu, 7 Mar 2024 11:36:06 -0500 Subject: [PATCH] Update body documentation in readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e20f44d..34c3266 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ This action will create a GitHub release and optionally upload an artifact to it | artifactErrorsFailBuild | An optional flag which indicates if artifact read or upload errors should fail the build. | false | "" | | artifacts | An optional set of paths representing artifacts to upload to the release. This may be a single path or a comma delimited list of paths (or globs) | false | "" | | artifactContentType | The content type of the artifact. Defaults to raw | false | "" | -| body | An optional body for the release. | false | "" | +| body | An optional body for the release. Note: This input will have white space trimmed before and after it. Use `bodyFile` if you need a non-trivial markdown body. | false | "" | | bodyFile | An optional body file for the release. This should be the path to the file. | false | "" | | commit | An optional commit reference. This will be used to create the tag if it does not exist. | false | "" | | discussionCategory | When provided this will generate a discussion of the specified category. The category must exist otherwise this will cause the action to fail. This isn't used with draft releases. The default "Announcements" category is not supported via the API and will cause an error if used here. | false | "" |