Skip to content

Commit 2303942

Browse files
📖 [Docs]: Remove unused configuration options from README (#52)
## Description This pull request updates the `README.md` file to simplify the list of configurable settings for the action. It removes several less commonly used settings to streamline the documentation and make it easier to read. Documentation cleanup: * [`README.md`](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L63-L66): Removed the following settings from the configuration list: `Debug`, `Verbose`, `Version`, and `Prerelease`. These settings are no longer included in the documentation to simplify the list and focus on the most relevant options. ## Type of change <!-- Use the check-boxes [x] on the options that are relevant. --> - [x] 📖 [Docs] - [ ] 🪲 [Fix] - [ ] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist <!-- Use the check-boxes [x] on the options that are relevant. --> - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas
1 parent 9cf3a80 commit 2303942

2 files changed

Lines changed: 2 additions & 4 deletions

File tree

README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,6 @@ The action can be configured using the following settings:
6060
| `PatchLabels` | A comma separated list of labels that trigger a patch release. | `false` | `patch, fix` |
6161
| `IgnoreLabels` | A comma separated list of labels that do not trigger a release. | `false` | `NoRelease` |
6262
| `WhatIf` | Control wether to simulate the action. If enabled, the action will not create any releases. Used for testing. | `false` | `false` |
63-
| `Debug` | Enable debug output. | `'false'` | `false` |
64-
| `Verbose` | Enable verbose output. | `'false'` | `false` |
65-
| `Version` | Specifies the version of the GitHub module to be installed. The value must be an exact version. | | `false` |
66-
| `Prerelease` | Allow prerelease versions if available. | `'false'` | `false` |
6763
| `WorkingDirectory` | The working directory where the script runs. | `'false'` | `'.'` |
6864

6965
## Example

scripts/main.ps1

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ Set-GitHubLogGroup "Loading helper scripts from [$path]" {
2525
}
2626
}
2727

28+
$env:GITHUB_REPOSITORY_NAME = $env:GITHUB_REPOSITORY -replace '.+/'
29+
2830
Set-GitHubLogGroup 'Loading inputs' {
2931
$name = if ([string]::IsNullOrEmpty($env:PSMODULE_PUBLISH_PSMODULE_INPUT_Name)) {
3032
$env:GITHUB_REPOSITORY_NAME

0 commit comments

Comments
 (0)