From 0a31895a74d07286c880ab33cdcddf6b24602726 Mon Sep 17 00:00:00 2001 From: Federico Grandi Date: Sat, 13 May 2023 01:00:56 +0200 Subject: [PATCH 1/2] fix: read default token --- action.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/action.yml b/action.yml index 41e36f4..1340ff2 100644 --- a/action.yml +++ b/action.yml @@ -4,7 +4,8 @@ author: 'GitHub' inputs: repo-token: description: 'The GITHUB_TOKEN secret' - required: true + required: false + default: '${{ github.token }}' configuration-path: description: 'Path to the labeler.yml configuration file' required: true From a404b2cdc94c5e1c829232e0c4c1adeccdeac03d Mon Sep 17 00:00:00 2001 From: Federico Grandi Date: Sat, 13 May 2023 01:04:02 +0200 Subject: [PATCH 2/2] docs: update README --- README.md | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 683867f..2cd7a2d 100644 --- a/README.md +++ b/README.md @@ -30,19 +30,21 @@ critical: Create a workflow (eg: `.github/workflows/labeler.yml` see [Creating a Workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file)) to utilize the labeler action with content: -``` +```yml name: "Issue Labeler" on: issues: types: [opened, edited] +permissions: + issues: write + jobs: triage: runs-on: ubuntu-latest steps: - uses: github/issue-labeler@v2.5 #May not be the latest version with: - repo-token: "${{ secrets.GITHUB_TOKEN }}" configuration-path: .github/labeler.yml not-before: 2020-01-15T02:54:32Z enable-versioned-regex: 0 @@ -50,16 +52,13 @@ jobs: `not-before` is optional and will result in any issues prior to this timestamp to be ignored. -_Note: The above workflow grants access to the `GITHUB_TOKEN` so the action can make calls to GitHub's REST API._ - - ### Example using versioned issue templates As you iterate on your regular expressions, since maybe your issue template gets updated, this can have an impact on existing issues. The below allows you to version your regular expression definitions and pair them with issue templates. Below is the body of an example issue which has the version identifier `issue_labeler_regex_version` embedded. -``` +```md @@ -69,19 +68,21 @@ I have an urgent issue that requires someone's attention. Below is the workflow file -``` +```yml name: "Issue Labeler" on: issues: types: [opened, edited] +permissions: + issues: write + jobs: triage: runs-on: ubuntu-latest steps: - uses: github/issue-labeler@v2.5 #May not be the latest version with: - repo-token: "${{ secrets.GITHUB_TOKEN }}" configuration-path: .github/labeler.yml not-before: 2020-01-15T02:54:32Z enable-versioned-regex: 1 @@ -101,7 +102,7 @@ Set `body-missing-regex-label` to the name of the label that should be added to The labeler action is also available for pull requests. Make sure the workflow is triggered by pull requests. -``` +```yml on: pull_request: types: [opened, edited] @@ -111,19 +112,21 @@ on: Set `include-title` to `1` to include the issue title in addition to the body in the regular expression target. -``` +```yml name: "Issue Labeler" on: issues: types: [opened, edited] +permissions: + issues: write + jobs: triage: runs-on: ubuntu-latest steps: - uses: github/issue-labeler@v2.5 #May not be the latest version with: - repo-token: "${{ secrets.GITHUB_TOKEN }}" configuration-path: .github/labeler.yml enable-versioned-regex: 0 include-title: 1 @@ -134,14 +137,13 @@ jobs: By default, labels that no longer match are not removed from the issue. To enable this functionality, explicity set `sync-labels` to `1`. -``` +```yml jobs: triage: runs-on: ubuntu-latest steps: - uses: github/issue-labeler@v2.0 with: - repo-token: "${{ secrets.GITHUB_TOKEN }}" configuration-path: .github/labeler.yml enable-versioned-regex: 0 sync-labels: 1