Skip to content

Commit 49e26d7

Browse files
Revise inputs section to controls in README
Updated the README to clarify input parameters and their descriptions.
1 parent 073d4f5 commit 49e26d7

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

README.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,21 +35,31 @@ jobs:
3535
label-color: "050B1A" # optional
3636
```
3737
38-
## Inputs
38+
## Controls
3939
40-
| Name | Default | Description |
41-
| --- | --- | --- |
42-
| `include-drafts` | `false` | Label draft pull requests when set to `true`. |
43-
| `bots` | `false` | Allow PRs opened by bot accounts to be labeled. |
44-
| `required-title-keywords` | `""` | Comma-separated keywords; at least one must match the PR title (case-insensitive). Prefix a keyword with `^` to require it at the start. Leave empty to disable. |
45-
| `exclude-title-keywords` | `""` | Comma-separated keywords that must not match the PR title. Prefix with `^` to anchor to the start; otherwise we check if the keyword appears anywhere. Leave empty to disable. |
46-
| `create-label` | `true` | Create the `codacy-review` label if it is missing. When `false`, the action exits without failure if the label does not exist. |
47-
| `label-color` | `050B1A` | Hex color (without `#`) to use when the label is auto-created. |
40+
* **`include-drafts`** (optional, default `false`)
41+
Labels draft pull requests when enabled.
42+
43+
* **`bots`** (optional, default: `false`)
44+
Labels pull requests opened by bot accounts (or accounts with [bot] in their name).
45+
46+
* **`required-title-keywords`** (optional, default: `""`)
47+
Comma-separated list. Labels pull requests only if its title contains at least one of these keywords. Use `^` as start anchor. Empty disables it.
48+
49+
* **`exclude-title-keywords`** (optional, default: `""`)
50+
Comma-separated list. Excludes labeling from pull requests that contain at least one of these keywords. Use `^` as start anchor. Empty disables it.
51+
52+
* **`create-label`** (optional, default: `true`)
53+
Creates the `codacy-review` label if missing from a repo. If set to `false`, PRs of that repo will not be labeled and the action will exit without failing.
54+
55+
* **`label-color`** (optional, default: `050B1A`)
56+
In case the label is created, you can set a Hex color override for the auto-created label (no `#` needed).
4857

4958

5059
## Troubleshooting
5160

5261
- Any errors encountered during the addition of the label will be returned as errors (e.g., permissions or missing tokens)
5362
- In case `create-label` is set to false, and the repo does not have the label already configured, the automatic addition will simply be skipped and logged.
63+
- When running the workflow in contexts where GitHub does not inject `secrets.GITHUB_TOKEN` (e.g., local testing with `act` or pull requests from forks), you must provide a personal access token yourself via the environment.
5464
- If you run into any trouble, feel free to reach out to us!
55-
- When running the workflow in contexts where GitHub does not inject `secrets.GITHUB_TOKEN` (e.g., local testing with `act` or pull requests from forks), you must provide a personal access token yourself via the environment; otherwise the action exits with `No token available`.
65+

0 commit comments

Comments
 (0)