Skip to content

Commit

Permalink
docs(readme): wrap labels in backticks
Browse files Browse the repository at this point in the history
  • Loading branch information
@abannachGrafana
abannachGrafana committed May 18, 2023
1 parent f8b1ec6 commit 5073775
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,24 @@ it does follow the syntax of `type(scope)!: message` where `(scope)` and `!` are

## Inputs

| key | description | default | required |
|--------------------|-----------------------------------------------------------|----------------------|----------|
| configuration-path | Path to the configuration file | `.github/pr-labeler` | `false` |
| token | Github access token with permission to add labels to a PR | | `true` |
| key | description | default | required |
|----------------------|-----------------------------------------------------------|----------------------|----------|
| `configuration-path` | Path to the configuration file | `.github/pr-labeler` | `false` |
| `token` | Github access token with permission to add labels to a PR | | `true` |

## Configuration

There is a default configuration that is provided, but if you would like to customize it add `pr-labeler.yml` to the
`.github/` directory.

| key | type | default | description |
|----------------------------|-----------|---------------------------------------|----------------------------------------------------------------------------------|
| add-missing-labels | `boolean` | `false` | Whether missing labels should be added to the repository |
| clear-prexisting | `boolean` | `true` | Whether the prexisting labels on the PR should be removed |
| include-commits | `boolean` | `false` | Whether to consider commit messages when adding labels |
| include-title | `boolean` | `true` | Whether to consider the pr title when adding labels |
| label-for-breaking-changes | `string` | `breaking` | The label to be used for breaking changes. Can be set to empty string to ignore |
| label-mapping | `object` | [See default config](#default-config) | Label to array of types for mapping. Labels and types can be whatever you decide |
| key | type | default | description |
|------------------------------|-----------|---------------------------------------|----------------------------------------------------------------------------------|
| `add-missing-labels` | `boolean` | `false` | Whether missing labels should be added to the repository |
| `clear-prexisting` | `boolean` | `true` | Whether the prexisting labels on the PR should be removed |
| `include-commits` | `boolean` | `false` | Whether to consider commit messages when adding labels |
| `include-title` | `boolean` | `true` | Whether to consider the pr title when adding labels |
| `label-for-breaking-changes` | `string` | `breaking` | The label to be used for breaking changes. Can be set to empty string to ignore |
| `label-mapping` | `object` | [See default config](#default-config) | Label to array of types for mapping. Labels and types can be whatever you decide |

### Default config

Expand Down

0 comments on commit 5073775

Please sign in to comment.