Skip to content

Commit

Permalink
docs: mention description limitations (#261)
Browse files Browse the repository at this point in the history
* Better informed users of limitations in GitHub label calls in documentation

* docs: minor formatting changes

---------

Co-authored-by: Federico Grandi <fgrandi30@gmail.com>
  • Loading branch information
andrewvaughan and EndBug authored Jan 19, 2024
1 parent 30af982 commit cca8d68
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ How to create a config file:
- Every label should be an array element: add some square brackets `[]` if you need to.
- Every element of the array should be an object with the following properties:
- `name` - The name of the label.
- `color` - The color of the label.
- `description` - [optional] The description of the label.
- `color` - The color of the label, with or without a leading `#`.
- `description` - [optional] The description of the label ([max 100 characters](https://docs.github.com/en/rest/issues/labels?apiVersion=2022-11-28#create-a-label)).
- `aliases` - [optional] An array containing the "aliases" of the label. If an existing label's name is an alias that label will be edited to match your config: this way you don't loose issues and PRs that have been labeled previously.

This is how it would end up looking:
Expand Down

0 comments on commit cca8d68

Please sign in to comment.