Skip to content

Commit

Permalink
Rename allow_missing_changelog option to allow-missing-changelog
Browse files Browse the repository at this point in the history
Change to kebab-case, which is the same as the existing `computed-prefix`
output option.
  • Loading branch information
taiki-e committed Mar 22, 2023
1 parent af4bdea commit 31c9781
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 7 deletions.
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ Note: In this file, do not use the hard wrap in the middle of a sentence for com

### Added

- Added new input `allow_missing_changelog:boolean` that will allow the build to continue to run even though the targeted version was not found on the changelog file. The default of this input is `false` to stay backwards compatible.
- Add `allow-missing-changelog` input option to allow create the release even if the changelog entry corresponding to the version is missing. ([#23](https://github.com/taiki-e/create-gh-release-action/pull/23), thanks @lmajano)

- Switch to composite action. ([#24](https://github.com/taiki-e/create-gh-release-action/pull/24))

## [1.6.3] - 2023-03-19

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Currently, changelog format and supported tag names have the following rule:
|-----------|:------------:|-----------------------------------------------------------------------------|---------|---------|
| token | **true** [^1]| GitHub token for creating GitHub Releases (see [action.yml](action.yml) for more) | String | |
| changelog | false | Path to changelog (variables `$tag`, `$version`, `$prefix`, and any string) | String | |
| allow_missing_changelog | false | Allows for the build to continue even if the version is not found in the changelog. The default value of the changelog will be an empty string. | Boolean | `false` |
| allow-missing-changelog | false | Create the release even if the changelog entry corresponding to the version is missing. The default value of the changelog will be an empty string. | Boolean | `false` |
| title | false | Format of title (variables `$tag`, `$version`, `$prefix`, and any string) | String | `$tag` |
| draft | false | Create a draft release (`true` or `false`) | Boolean | `false` |
| branch | false | Reject releases from commits not contained in branches that match the specified pattern (regular expression) | String | |
Expand Down
9 changes: 4 additions & 5 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,10 @@ inputs:
changelog:
description: Path to changelog (variables `$tag`, `$version`, `$prefix`, and any string)
required: false
allow_missing_changelog:
allow-missing-changelog:
description: >
If true, it will create the GitHub release with an empty notes for the changelog if the changelog.md file does not
have the appropriate version in it. By default, this action will fail if the version tagged is not found in the
changelog file.
Create the release even if the changelog entry corresponding to the version is missing.
The default value of the changelog will be an empty string.
required: false
default: 'false'
title:
Expand Down Expand Up @@ -78,7 +77,7 @@ runs:
shell: bash
env:
INPUT_CHANGELOG: ${{ inputs.changelog }}
INPUT_ALLOW_MISSING_CHANGELOG: ${{ inputs.allow_missing_changelog }}
INPUT_ALLOW_MISSING_CHANGELOG: ${{ inputs.allow-missing-changelog }}
INPUT_TITLE: ${{ inputs.title }}
INPUT_DRAFT: ${{ inputs.draft }}
INPUT_BRANCH: ${{ inputs.branch }}
Expand Down

0 comments on commit 31c9781

Please sign in to comment.