actions/labeler
1
0
Fork 0
mirror of https://github.com/actions/labeler.git synced 2025-12-12 12:37:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' into main

Browse Source
This commit is contained in:
Josh Dales
2023-03-08 18:10:37 -05:00
committed by GitHub
parent 5e6bdf6d89 ba790c862c
commit 84e83a9b19
7 changed files with 33 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/release-new-action-version.yml vendored
View File

@@ -22,7 +22,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Update the ${{ env.TAG_NAME }} tag - name: Update the ${{ env.TAG_NAME }} tag
uses: actions/publish-action@v0.2.1 uses: actions/publish-action@v0.2.2
with: with:
source-tag: ${{ env.TAG_NAME }} source-tag: ${{ env.TAG_NAME }}
slack-webhook: ${{ secrets.SLACK_WEBHOOK }} slack-webhook: ${{ secrets.SLACK_WEBHOOK }}

17
README.md
View File

@@ -1,13 +1,6 @@
# Pull Request Labeler # Pull Request Labeler
<p align="left"> [![Basic validation](https://github.com/actions/labeler/actions/workflows/basic-validation.yml/badge.svg?branch=main)](https://github.com/actions/labeler/actions/workflows/basic-validation.yml)
<a href="https://github.com/actions/labeler/actions/workflows/basic-validation.yml">
<img alt="basic validation status" src="https://github.com/actions/labeler/actions/workflows/basic-validation.yml/badge.svg">
</a>
<a href="https://libraries.io/github/actions/labeler">
<img alt="dependencies" src="https://img.shields.io/librariesio/github/actions/labeler">
</a>
</p>
Automatically label new pull requests based on the paths of files being changed or the branch name. Automatically label new pull requests based on the paths of files being changed or the branch name.
@@ -133,21 +126,17 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/labeler@v5 - uses: actions/labeler@v5
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
``` ```
_Note: This grants access to the `GITHUB_TOKEN` so the action can make calls to GitHub's rest API_
#### Inputs #### Inputs
Various inputs are defined in [`action.yml`](action.yml) to let you configure the labeler: Various inputs are defined in [`action.yml`](action.yml) to let you configure the labeler:
| Name | Description | Default | | Name | Description | Default |
| - | - | - | | - | - | - |
| `repo-token` | Token to use to authorize label changes. Typically the GITHUB_TOKEN secret, with `contents:read` and `pull-requests:write` access | N/A | | `repo-token` | Token to use to authorize label changes. Typically the GITHUB_TOKEN secret, with `contents:read` and `pull-requests:write` access | `github.token` |
| `configuration-path` | The path to the label configuration file | `.github/labeler.yml` | | `configuration-path` | The path to the label configuration file | `.github/labeler.yml` |
| `sync-labels` | Whether or not to remove labels when matching files are reverted or no longer changed by the PR | `false` | `sync-labels` | Whether or not to remove labels when matching files are reverted or no longer changed by the PR | `false`|
# Contributions # Contributions

4
action.yml
View File

@@ -3,7 +3,9 @@ description: 'Automatically label new pull requests based on the paths of files
author: 'GitHub' author: 'GitHub'
inputs: inputs:
repo-token: repo-token:
description: 'The GITHUB_TOKEN secret' description: 'The GitHub token used to manage labels'
required: false
default: ${{ github.token }}
configuration-path: configuration-path:
description: 'The path for the label configurations' description: 'The path for the label configurations'
default: '.github/labeler.yml' default: '.github/labeler.yml'

2
dist/index.js vendored
View File

@@ -148,7 +148,7 @@ const branch_1 = __nccwpck_require__(8045);
function run() { function run() {
return __awaiter(this, void 0, void 0, function* () { return __awaiter(this, void 0, void 0, function* () {
try { try {
const token = core.getInput('repo-token', { required: true }); const token = core.getInput('repo-token');
const configPath = core.getInput('configuration-path', { required: true }); const configPath = core.getInput('configuration-path', { required: true });
const syncLabels = !!core.getInput('sync-labels', { required: false }); const syncLabels = !!core.getInput('sync-labels', { required: false });
const prNumber = getPrNumber(); const prNumber = getPrNumber();

42
package-lock.json generated
View File

@@ -19,11 +19,11 @@
"@types/js-yaml": "^4.0.5", "@types/js-yaml": "^4.0.5",
"@types/minimatch": "^5.1.2", "@types/minimatch": "^5.1.2",
"@types/node": "^16.11.7", "@types/node": "^16.11.7",
"@vercel/ncc": "^0.36.0", "@vercel/ncc": "^0.36.1",
"jest": "^27.5.1", "jest": "^27.5.1",
"prettier": "^2.8.1", "prettier": "^2.8.4",
"ts-jest": "^27.1.3", "ts-jest": "^27.1.3",
"typescript": "^4.9.4" "typescript": "^4.9.5"
} }
}, },
"node_modules/@actions/core": { "node_modules/@actions/core": {
@@ -1210,9 +1210,9 @@
"dev": true "dev": true
}, },
"node_modules/@vercel/ncc": { "node_modules/@vercel/ncc": {
"version": "0.36.0", "version": "0.36.1",
"resolved": "https://registry.npmjs.org/@vercel/ncc/-/ncc-0.36.0.tgz", "resolved": "https://registry.npmjs.org/@vercel/ncc/-/ncc-0.36.1.tgz",
"integrity": "sha512-/ZTUJ/ZkRt694k7KJNimgmHjtQcRuVwsST2Z6XfYveQIuBbHR+EqkTc1jfgPkQmMyk/vtpxo3nVxe8CNuau86A==", "integrity": "sha512-S4cL7Taa9yb5qbv+6wLgiKVZ03Qfkc4jGRuiUQMQ8HGBD5pcNRnHeYM33zBvJE4/zJGjJJ8GScB+WmTsn9mORw==",
"dev": true, "dev": true,
"bin": { "bin": {
"ncc": "dist/ncc/cli.js" "ncc": "dist/ncc/cli.js"
@@ -3606,9 +3606,9 @@
} }
}, },
"node_modules/prettier": { "node_modules/prettier": {
"version": "2.8.2", "version": "2.8.4",
"resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.2.tgz", "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.4.tgz",
"integrity": "sha512-BtRV9BcncDyI2tsuS19zzhzoxD8Dh8LiCx7j7tHzrkz8GFXAexeWFdi22mjE1d16dftH2qNaytVxqiRTGlMfpw==", "integrity": "sha512-vIS4Rlc2FNh0BySk3Wkd6xmwxB0FpOndW5fisM5H8hsZSxU2VWVB5CWIkIjWvrHjIhxk2g3bfMKM87zNTrZddw==",
"dev": true, "dev": true,
"bin": { "bin": {
"prettier": "bin-prettier.js" "prettier": "bin-prettier.js"
@@ -4220,9 +4220,9 @@
} }
}, },
"node_modules/typescript": { "node_modules/typescript": {
"version": "4.9.4", "version": "4.9.5",
"resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.4.tgz", "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.5.tgz",
"integrity": "sha512-Uz+dTXYzxXXbsFpM86Wh3dKCxrQqUcVMxwU54orwlJjOpO3ao8L7j5lH+dWfTwgCwIuM9GQ2kvVotzYJMXTBZg==", "integrity": "sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==",
"dev": true, "dev": true,
"bin": { "bin": {
"tsc": "bin/tsc", "tsc": "bin/tsc",
@@ -5489,9 +5489,9 @@
"dev": true "dev": true
}, },
"@vercel/ncc": { "@vercel/ncc": {
"version": "0.36.0", "version": "0.36.1",
"resolved": "https://registry.npmjs.org/@vercel/ncc/-/ncc-0.36.0.tgz", "resolved": "https://registry.npmjs.org/@vercel/ncc/-/ncc-0.36.1.tgz",
"integrity": "sha512-/ZTUJ/ZkRt694k7KJNimgmHjtQcRuVwsST2Z6XfYveQIuBbHR+EqkTc1jfgPkQmMyk/vtpxo3nVxe8CNuau86A==", "integrity": "sha512-S4cL7Taa9yb5qbv+6wLgiKVZ03Qfkc4jGRuiUQMQ8HGBD5pcNRnHeYM33zBvJE4/zJGjJJ8GScB+WmTsn9mORw==",
"dev": true "dev": true
}, },
"abab": { "abab": {
@@ -7308,9 +7308,9 @@
"dev": true "dev": true
}, },
"prettier": { "prettier": {
"version": "2.8.2", "version": "2.8.4",
"resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.2.tgz", "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.4.tgz",
"integrity": "sha512-BtRV9BcncDyI2tsuS19zzhzoxD8Dh8LiCx7j7tHzrkz8GFXAexeWFdi22mjE1d16dftH2qNaytVxqiRTGlMfpw==", "integrity": "sha512-vIS4Rlc2FNh0BySk3Wkd6xmwxB0FpOndW5fisM5H8hsZSxU2VWVB5CWIkIjWvrHjIhxk2g3bfMKM87zNTrZddw==",
"dev": true "dev": true
}, },
"pretty-format": { "pretty-format": {
@@ -7751,9 +7751,9 @@
} }
}, },
"typescript": { "typescript": {
"version": "4.9.4", "version": "4.9.5",
"resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.4.tgz", "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.5.tgz",
"integrity": "sha512-Uz+dTXYzxXXbsFpM86Wh3dKCxrQqUcVMxwU54orwlJjOpO3ao8L7j5lH+dWfTwgCwIuM9GQ2kvVotzYJMXTBZg==", "integrity": "sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==",
"dev": true "dev": true
}, },
"universal-user-agent": { "universal-user-agent": {

6
package.json
View File

@@ -33,10 +33,10 @@
"@types/node": "^16.11.7", "@types/node": "^16.11.7",
"@types/minimatch": "^5.1.2", "@types/minimatch": "^5.1.2",
"@types/js-yaml": "^4.0.5", "@types/js-yaml": "^4.0.5",
"@vercel/ncc": "^0.36.0", "@vercel/ncc": "^0.36.1",
"jest": "^27.5.1", "jest": "^27.5.1",
"prettier": "^2.8.1", "prettier": "^2.8.4",
"ts-jest": "^27.1.3", "ts-jest": "^27.1.3",
"typescript": "^4.9.4" "typescript": "^4.9.5"
} }
} }

2
src/labeler.ts
View File

@@ -18,7 +18,7 @@ type ClientType = ReturnType<typeof github.getOctokit>;
export async function run() { export async function run() {
try { try {
const token = core.getInput('repo-token', {required: true}); const token = core.getInput('repo-token');
const configPath = core.getInput('configuration-path', {required: true}); const configPath = core.getInput('configuration-path', {required: true});
const syncLabels = !!core.getInput('sync-labels', {required: false}); const syncLabels = !!core.getInput('sync-labels', {required: false});