Skip to content

Commit d78fc8e

Browse files
🩹 [Patch]: Fix typos in descriptions for action inputs in README.md and action.yml
1 parent 0f6c360 commit d78fc8e

2 files changed

Lines changed: 11 additions & 11 deletions

File tree

‎README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,22 +39,22 @@ The action can be configured using the following settings:
3939

4040
| Name | Description | Default | Required |
4141
| --- | --- | --- | --- |
42-
| `AutoCleanup`| Control wether to automatically cleanup prereleases. If disabled, the action will not remove any prereleases. | `true` | false |
43-
| `AutoPatching` | Control wether to automatically handle patches. If disabled, the action will only create a patch release if the pull request has a 'patch' label. | `true` | false |
42+
| `AutoCleanup`| Control whether to automatically cleanup prereleases. If disabled, the action will not remove any prereleases. | `true` | false |
43+
| `AutoPatching` | Control whether to automatically handle patches. If disabled, the action will only create a patch release if the pull request has a 'patch' label. | `true` | false |
4444
| `ConfigurationFile` | The path to the configuration file. Settings in the configuration file take precedence over the action inputs. | `.github\auto-release.yml` | false |
45-
| `CreateMajorTag` | Control wether to create a tag for major releases. | `true` | false |
46-
| `CreateMinorTag` | Control wether to create a tag for minor releases. | `true` | false |
45+
| `CreateMajorTag` | Control whether to create a tag for major releases. | `true` | false |
46+
| `CreateMinorTag` | Control whether to create a tag for minor releases. | `true` | false |
4747
| `DatePrereleaseFormat` | The format to use for the prerelease number using [.NET DateTime format strings](https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings). | `''` | false |
4848
| `IgnoreLabels` | A comma separated list of labels that do not trigger a release. | `NoRelease` | false |
49-
| `IncrementalPrerelease` | Control wether to automatically increment the prerelease number. If disabled, the action will ensure only one prerelease exists for a given branch. | `true` | false |
49+
| `IncrementalPrerelease` | Control whether to automatically increment the prerelease number. If disabled, the action will ensure only one prerelease exists for a given branch. | `true` | false |
5050
| `MajorLabels` | A comma separated list of labels that trigger a major release. | `major, breaking` | false |
5151
| `MinorLabels` | A comma separated list of labels that trigger a minor release. | `minor, feature` | false |
5252
| `PatchLabels` | A comma separated list of labels that trigger a patch release. | `patch, fix` | false |
5353
| `UsePRTitleAsReleaseName` | When enabled, uses the pull request title as the name for the GitHub release. | `false` | false |
5454
| `UsePRBodyAsReleaseNotes` | When enabled, uses the pull request body as the release notes for the GitHub release. | `true` | false |
5555
| `UsePRTitleAsNotesHeading` | When enabled, the release notes will begin with the pull request title as a H1 heading followed by the pull request body. The title will include a reference to the PR number. | `true` | false |
5656
| `VersionPrefix` | The prefix to use for the version number. | `v` | false |
57-
| `WhatIf` | Control wether to simulate the action. If enabled, the action will not create any releases. Used for testing. | `false` | false |
57+
| `WhatIf` | Control whether to simulate the action. If enabled, the action will not create any releases. Used for testing. | `false` | false |
5858
| `Debug` | Enable debug output. | `'false'` | false |
5959
| `Verbose` | Enable verbose output. | `'false'` | false |
6060
| `Version` | Specifies the exact version of the GitHub module to install. | | false |

‎action.yml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,23 @@ branding:
77

88
inputs:
99
AutoCleanup:
10-
description: Control wether to automatically delete the prerelease tags after the stable release is created.
10+
description: Control whether to automatically delete the prerelease tags after the stable release is created.
1111
required: false
1212
default: 'true'
1313
AutoPatching:
14-
description: Control wether to automatically handle patches. If disabled, the action will only create a patch release if the pull request has a 'patch' label.
14+
description: Control whether to automatically handle patches. If disabled, the action will only create a patch release if the pull request has a 'patch' label.
1515
required: false
1616
default: 'true'
1717
ConfigurationFile:
1818
description: The path to the configuration file. Settings in the configuration file take precedence over the action inputs.
1919
required: false
2020
default: .github\auto-release.yml
2121
CreateMajorTag:
22-
description: Control wether to create a major tag when a pull request is merged into the main branch.
22+
description: Control whether to create a major tag when a pull request is merged into the main branch.
2323
required: false
2424
default: 'true'
2525
CreateMinorTag:
26-
description: Control wether to create a minor tag when a pull request is merged into the main branch.
26+
description: Control whether to create a minor tag when a pull request is merged into the main branch.
2727
required: false
2828
default: 'true'
2929
DatePrereleaseFormat:
@@ -35,7 +35,7 @@ inputs:
3535
required: false
3636
default: NoRelease
3737
IncrementalPrerelease:
38-
description: Control wether to automatically increment the prerelease number. If disabled, the action will ensure only one prerelease exists for a given branch.
38+
description: Control whether to automatically increment the prerelease number. If disabled, the action will ensure only one prerelease exists for a given branch.
3939
required: false
4040
default: 'true'
4141
MajorLabels:

0 commit comments

Comments
 (0)