From 3e3985fd731bfc1fa30452a834537d087a7f60cf Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 24 May 2024 10:39:10 -0400 Subject: [PATCH] fix!: change default behavior of artifactErrorsFailBuild (#146) --- README.md | 29 +++++++++++++++-------------- action.yml | 6 +++++- 2 files changed, 20 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index f3f5bf0..24db8a0 100644 --- a/README.md +++ b/README.md @@ -24,20 +24,21 @@ steps: ## Inputs -| Name | Description | Default | Required | -|------------------------|---------------------------------------------------------------------------------------------------|-----------------|----------| -| allowUpdates | An optional flag which indicates if we should update a release if it already exists. | `true` | `false` | -| artifacts | The artifacts to upload. | `*artifacts/*` | `false` | -| body | The body of the release. | | `false` | -| deleteOtherPreReleases | Whether to delete other pre-releases. | `true` | `false` | -| deletePreReleaseTags | Whether to delete other pre-release tags. | `true` | `false` | -| discussionCategory | The category for the discussion. | `announcements` | `false` | -| generateReleaseNotes | Indicates if release notes should be automatically generated. | `true` | `false` | -| keepPreReleaseCount | The number of pre-releases to keep. | `2` | `false` | -| name | The version to create. | | `true` | -| prerelease | Whether the release is a prerelease. | `true` | `false` | -| tag | The tag to create. | | `true` | -| token | GitHub Token. | | `true` | +| Name | Description | Default | Required | +|-------------------------|------------------------------------------------------------------------------------------------------|-----------------|----------| +| allowUpdates | An optional flag which indicates if we should update a release if it already exists. | `true` | `false` | +| artifactErrorsFailBuild | An optional flag which indicates if we should fail the build if there are errors with the artifacts. | `false` | `false` | +| artifacts | The artifacts to upload. | `*artifacts/*` | `false` | +| body | The body of the release. | | `false` | +| deleteOtherPreReleases | Whether to delete other pre-releases. | `true` | `false` | +| deletePreReleaseTags | Whether to delete other pre-release tags. | `true` | `false` | +| discussionCategory | The category for the discussion. | `announcements` | `false` | +| generateReleaseNotes | Indicates if release notes should be automatically generated. | `true` | `false` | +| keepPreReleaseCount | The number of pre-releases to keep. | `2` | `false` | +| name | The version to create. | | `true` | +| prerelease | Whether the release is a prerelease. | `true` | `false` | +| tag | The tag to create. | | `true` | +| token | GitHub Token. | | `true` | ## See Also diff --git a/action.yml b/action.yml index 4730818..e0ab205 100644 --- a/action.yml +++ b/action.yml @@ -7,6 +7,10 @@ inputs: description: 'An optional flag which indicates if we should update a release if it already exists.' required: false default: 'true' + artifactErrorsFailBuild: + description: 'An optional flag which indicates if we should fail the build if there are errors with the artifacts.' + required: false + default: 'false' artifacts: description: 'The artifacts to upload.' required: false @@ -59,7 +63,7 @@ runs: uses: ncipollo/release-action@v1.14.0 with: allowUpdates: ${{ inputs.allowUpdates }} - artifactErrorsFailBuild: true + artifactErrorsFailBuild: ${{ inputs.artifactErrorsFailBuild }} artifacts: ${{ inputs.artifacts }} body: ${{ inputs.body }} commit: ${{ github.sha }}