You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-10Lines changed: 20 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,21 +35,31 @@ jobs:
35
35
label-color: "050B1A"# optional
36
36
```
37
37
38
-
## Inputs
38
+
## Controls
39
39
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. |
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).
48
57
49
58
50
59
## Troubleshooting
51
60
52
61
- Any errors encountered during the addition of the label will be returned as errors (e.g., permissions or missing tokens)
53
62
- 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.
54
64
- 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`.
0 commit comments