Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/seantrane/github-label-presets
:octocat: GitHub Labels that are logical, colorful and sensible.
https://github.com/seantrane/github-label-presets
github-labels issue-management issues pull-requests
Last synced: 2 months ago
JSON representation
:octocat: GitHub Labels that are logical, colorful and sensible.
- Host: GitHub
- URL: https://github.com/seantrane/github-label-presets
- Owner: seantrane
- License: isc
- Created: 2018-08-18T13:19:15.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2023-04-13T08:53:04.000Z (almost 2 years ago)
- Last Synced: 2024-10-14T03:18:50.102Z (3 months ago)
- Topics: github-labels, issue-management, issues, pull-requests
- Language: Shell
- Size: 195 KB
- Stars: 18
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# @seantrane/github-label-presets
> :octocat: GitHub Labels that are logical, colorful and sensible.
[](http://commitizen.github.io/cz-cli/) [](https://github.com/semantic-release/semantic-release) [](https://github.com/seantrane/github-label-presets/actions/workflows/integration.yml) [](https://github.com/seantrane/github-label-presets/actions/workflows/delivery.yml)
**TL;DR:** _Want [beautiful GitHub Labels like these](https://github.com/seantrane/github-label-presets/labels)?_ Want to have them unobtrusively synced with your repos? Want to persist them indefinitely? Want to maintain your own labels? If the answers have been yes, this is definitely not _too long_, please read on.
1. Run `npm install -g github-label-sync`
2. Provide environment variable: `GITHUB_ACCESS_TOKEN`
3. Run `github-label-sync -l 'https://raw.githubusercontent.com/seantrane/github-label-presets/main/labels.json' myname/myrepo`
> :robot: :rocket: [Use GitHub Actions to keep your labels just how you like them!](#github-actions)
### Details
The default GitHub Labels are... not ideal. This has been described many times:
- [Sane GitHub Labels](https://medium.com/@dave_lunny/sane-github-labels-c5d2e6004b63)
- [How we organize GitHub issues: A simple styleguide for tagging](https://robinpowered.com/blog/best-practice-system-for-organizing-and-tagging-github-issues/)
There are many very good examples of GitHub Label strategies. Almost all of them are an improvement over the default. But for several reasons or another few, in practice, none of them have felt truly great or sustainable.
#### Principles
`@seantrane/github-label-presets` were designed according to the following thoughts and principles:
- GitHub Labels are used for both Issues and Pull Requests (PR), therefore the label context should be agnostic.
- An Issue/PR without labels should not require labels to solicit attention, therefore the default state should be label-less.
- Issue/PR labels should only provide important context; priority, effort and the state of solution and/or decision-making.
- _"High Priority"_, sure, but _"Low Priority"_ is a joke; go label-less instead.
- Labels and their associated colors should have a logical connection that is intuitive at-a-glance.
- Labels should be lowercase. It's easier to type and less competitive with Label-names.
- Prefixes matter. Labels get chaotic without them. The chosen are;
- `effort` = relative effort involved, fibonacci from `1` to `13`
- `priority` = designate immediacy; `now`, `2day` or `soon`
- `state` = describe decision; `approved`, `blocked`, `inactive` or `pending`
- `type` = describe type; `bug`, `chore`, `discussion`, `docs`, `feature`, `fix`, `security`, `testing`
- `work` = describe situation; `chaotic`, `complex`, `complicated` or `obvious`
- The only labels without prefixes are; `breaking`, `good first issue`, `greenkeeper`, `help` and `semantic-release`
#### Label Groups
| Standard | Effort | Priority | State | Type | Work |
| -------- | ------ | -------- | ----- | ---- | ---- |
| Standard labels commonly used in most repositories. | Describes the relative effort to complete an issue or pull request. | Priority labels, but focused on describing the immediacy of attention required. | Describes the _decision_ state of the issue or pull request. | Describes the _type_ of issue or pull request. | Describes the kind of work involved in resolving the issue, using the [Cynefin framework](https://en.wikipedia.org/wiki/Cynefin_framework). |
|  |  |  |  |  |  |
#### How It Works
- [`github-label-sync`](https://github.com/Financial-Times/github-label-sync) is used to _synchronize your GitHub labels with as few destructive operations as possible - similar labels get renamed_.
- The [label config](https://github.com/Financial-Times/github-label-sync#label-json) is loaded via path or URL, or more specifically; the config file supplied by [`@seantrane/github-label-presets`](https://github.com/seantrane/github-label-presets).
- The `github-label-sync -l 'https://raw.githubusercontent.com/seantrane/github-label-presets/main/labels.json' myname/myrepo` command is run to have the label config applied to _your_ `profile/repo`.
- The command can be run anywhere and anytime, but it's recommended during a CI plan. This will automatically keep your labels clean and synchronized with your chosen configuration - depending on how often your plan is run, of course.
**Required:** [Generate a GitHub Access Token](https://github.com/settings/tokens), provide it via `GITHUB_ACCESS_TOKEN` environment variable. _If you cannot provide token as an environment variable, you may also pass it via CLI._
1. Install `npm install -g github-label-sync`
2. Dry-run `github-label-sync -d -l 'https://raw.githubusercontent.com/seantrane/github-label-presets/main/labels.json' /`
3. Run `github-label-sync -l 'https://raw.githubusercontent.com/seantrane/github-label-presets/main/labels.json' /`
4. [Optional] Provide token via CLI param: `github-label-sync -a -l ...`
You can use your CI/CD process to automate the periodic syncing of your repository labels. This can help persist order automatically.
1. Create a `.github/workflows/labels.yml` file in your repository.
2. Copy/paste the following code block in that file.
3. [Optional] Change `branches` to match your repository preferences.
```yaml
---
name: "Maintain Repository Labels"
on:
label:
types: [created, edited, deleted]
push:
branches: [master, main]
paths:
- .github/labels.json
- .github/labels.yml
- .github/workflows/labels.yml
workflow_dispatch:
permissions:
issues: write
pull-requests: write
repository-projects: write
jobs:
labelsync:
# https://github.com/seantrane/github-label-presets
name: GitHub Label Presets, Sync
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: lts
- run: |
npm i -g github-label-sync
github-label-sync -l "$LABEL_CONFIG_PATH" "$LABEL_REPOSITORY"
env:
GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
LABEL_REPOSITORY: ${{ github.repository }}
# Use github-label-presets:
LABEL_CONFIG_PATH: https://raw.githubusercontent.com/seantrane/github-label-presets/main/labels.json
# Use your own labels:
# LABEL_CONFIG_PATH: .github/labels.json
```
### Config your own...
You can provide your own `labels.json` via the `[ -l, --lables ]` argument.
Contributions are always appreciated. Read [CONTRIBUTING.md](https://github.com/seantrane/github-label-presets/blob/main/CONTRIBUTING.md) documentation to learn more.
Release details are documented in the [CHANGELOG.md](https://github.com/seantrane/github-label-presets/blob/main/CHANGELOG.md) file, and on the [GitHub Releases page](https://github.com/seantrane/github-label-presets/releases).
---
[ISC License](https://github.com/seantrane/github-label-presets/blob/main/LICENSE)
Copyright (c) 2018 [Sean Trane Sciarrone](https://github.com/seantrane)