Skip to content

Better informed users of limitations in GitHub label calls in documentation (closes #260) #261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 19, 2024
Merged

Better informed users of limitations in GitHub label calls in documentation (closes #260) #261

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
198037c
Better informed users of limitations in GitHub label calls in documen…
andrewvaughan Jan 15, 2024
090a674
docs: minor formatting changes
EndBug Jan 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,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