Skip to content

Commit

Permalink
Merge pull request #219 from crazy-max/update-readme
Browse files Browse the repository at this point in the history
readme: set required permissions
  • Loading branch information
crazy-max authored Oct 26, 2024
2 parents b54af0c + e63d263 commit f5345dd
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 34 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,18 @@ looks like:

```yaml
- name: "bug"
color: "d73a4a"
color: "#d73a4a"
description: "Something isn't working"
- name: "documentation"
color: "0075ca"
color: "#0075ca"
description: "Improvements or additions to documentation"
- name: "duplicate"
color: "cfd8d7"
color: "#cfd8d7"
description: "This issue or pull request already exists"
- name: "enhancement"
color: "a22eef"
color: "#a22eef"
- name: "wontfix_it"
color: "000000"
color: "#000000"
description: "This will not be worked on"
from_name: "wontfix"
```
Expand All @@ -51,8 +51,6 @@ looks like:
* `description` can be omit if your want to keep the current one
* `from_name` allow to rename a label from one currently available on your repository

**Note:** You can use hex codes for the `color` field, as that helps previewing the colors in some code editors. The leading "#" will be automatically removed.

### Workflow

```yaml
Expand All @@ -73,10 +71,13 @@ on:
jobs:
labeler:
runs-on: ubuntu-latest
permissions:
content: read
issues: write
steps:
-
name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
-
name: Run Labeler
uses: crazy-max/ghaction-github-labeler@v5
Expand Down
34 changes: 17 additions & 17 deletions samples/fancy.yml
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
- name: ":ant: bug"
color: "ee0701"
color: "#ee0701"
- name: ":busts_in_silhouette: duplicate"
color: "cccccc"
color: "#cccccc"
- name: ":computer: UX"
color: "ce12ce"
color: "#ce12ce"
- name: ":construction: maintenance"
color: "fbca04"
color: "#fbca04"
- name: ":hatching_chick: good first issue"
color: "7057ff"
color: "#7057ff"
- name: ":interrobang: maybe-bug"
color: "5fc1ce"
color: "#5fc1ce"
description: "Something that might be a bug if more info is given"
- name: ":jack_o_lantern: hacktoberfest"
color: "ffaa04"
color: "#ffaa04"
- name: ":mega: feedback"
color: "ecef8d"
color: "#ecef8d"
- name: ":memo: docs"
color: "c2e0c6"
color: "#c2e0c6"
- name: ":no_entry_sign: invalid"
color: "e6e6e6"
color: "#e6e6e6"
- name: ":pray: help wanted"
color: "33aa3f"
color: "#33aa3f"
- name: ":question: question"
color: "eaf961"
color: "#eaf961"
- name: ":rocket: future-maybe"
color: "fef2c0"
color: "#fef2c0"
- name: ":sparkles: enhancement"
color: "84b6eb"
color: "#84b6eb"
- name: ":thinking: needs more info"
color: "31e0ab"
color: "#31e0ab"
- name: ":thought_balloon: proposal"
color: "1a388c"
color: "#1a388c"
description: "Requested major feature or change of behavior"
- name: ":x: wontfix"
color: "ffffff"
color: "#ffffff"
18 changes: 9 additions & 9 deletions samples/original.yml
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
- name: "bug"
color: "d73a4a"
color: "#d73a4a"
description: "Something isn't working"
- name: "documentation"
color: "0075ca"
color: "#0075ca"
description: "Improvements or additions to documentation"
- name: "duplicate"
color: "cfd3d7"
color: "#cfd3d7"
description: "This issue or pull request already exists"
- name: "enhancement"
color: "a2eeef"
color: "#a2eeef"
description: "New feature or request"
- name: "good first issue"
color: "7057ff"
color: "#7057ff"
description: "Good for newcomers"
- name: "help wanted"
color: "008672"
color: "#008672"
description: "Extra attention is needed"
- name: "invalid"
color: "e4e669"
color: "#e4e669"
description: "This doesn't seem right"
- name: "question"
color: "d876e3"
color: "#d876e3"
description: "Further information is requested"
- name: "wontfix"
color: "ffffff"
color: "#ffffff"
description: "This will not be worked on"

0 comments on commit f5345dd

Please sign in to comment.