From 62a7618b4eb3e3dfbfe238e4b6bce2288df96dd0 Mon Sep 17 00:00:00 2001 From: Nick Cipollo Date: Tue, 26 May 2020 14:59:05 -0400 Subject: [PATCH] Organize readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5683a0a..87c6e3c 100644 --- a/README.md +++ b/README.md @@ -13,13 +13,13 @@ This action will create a github release and optionally upload an artifact to it - **draft**: Optionally marks this release as a draft release. Set to `true` to enable. - **name**: An optional name for the release. If this is omitted the tag will be used. - **omitBody**: Indicates if the release body should be omitted. This is primarily useful for preserving the release body during updates. +- **omitBodyDuringUpdate**: Indicates if the release body should be omitted during updates. The body will still be applied for newly created releases. This will preserve the existing body during updates. - **omitName**: Indicates if the release name should be omitted. This is primarily useful for preserving the release name during updates. +- **omitNameDuringUpdate**: Indicates if the release name should be omitted during updates. The name will still be applied for newly created releases. This will preserve the existing name during updates. - **prerelease**: Optionally marks this release as prerelease. Set to true to enable. - **replacesArtifacts**: Indicates if existing release artifacts should be replaced. Defaults to true. - **tag**: An optional tag for the release. If this is omitted the git ref will be used (if it is a tag). - **token**: (**Required**) The Github token. Typically this will be `${{ secrets.GITHUB_TOKEN }}`. -- **omitBodyDuringUpdate**: Indicates if the release body should be omitted during updates. The body will still be applied for newly created releases. This will preserve the existing body during updates. -- **omitNameDuringUpdate**: Indicates if the release name should be omitted during updates. The name will still be applied for newly created releases. This will preserve the existing name during updates. ## Example This example will create a release when tag is pushed: