feat: Remove dependency on .github/labels.yaml

Instead, use a first party `.prowlabels.yaml` file for labeling support

Signed-off-by: John McBirde <[email protected]>

Author: jpmcb

.github/workflows/prLabeler.yml

@@ -9,9 +9,3 @@ kind:
 priority:
   - 'low'
   - 'high'
-
-tests:
-  - '**/*.test.ts'
-
-source:
-  - 'src/**'

.github/labels.yaml renamed to .prowlabels.yaml

@@ -10,6 +10,7 @@ Check out the _"EXAMPLE"_ issues and pull requests (open and closed) in this rep
 
 ---
 Run specified actions or jobs for issue and PR comments through a `workflow.yaml` file:
+
 ```yaml
 name: "Prow github actions"
 on:
@@ -41,34 +42,8 @@ jobs:
           github-token: "${{ secrets.GITHUB_TOKEN }}"
 ```
 
-Automatically label PRs with the [Github actions/labeler](https://github.com/actions/labeler/blob/main/README.md) based on globs from `.github/labels.yml`:
-```yaml
-name: "Pull Request Labeler"
-on:
-- pull_request_target
-
-jobs:
-  triage:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/labeler@main
-      with:
-        repo-token: "${{ secrets.GITHUB_TOKEN }}"
-```
-
-Your `.github/labels.yaml` may look like:
-```yaml
-# labels to be used with /area command
-area:
-  - 'bug'
-  - 'important'
-
-# File globs for PR labeler
-tests:
-  - '**/*.test.ts'
-```
-
 You can automatically merge PRs based on a cron schedule if it contains the `lgtm` label:
+
 ```yaml
 name: "Merge on lgtm label"
 on:
@@ -89,6 +64,7 @@ jobs:
 ```
 
 Prow Github actions also supports removing the lgtm label when a PR is updated
+
 ```yaml
 name: "Run Jobs on PR"
 on: pull_request
@@ -115,6 +91,7 @@ jobs:
 - [Contributing](./docs/contributing.md)
 
 ---
+
 _open water breeze  
 the ocean seas are endless  
 forward to the prow_

README.md

@@ -3,7 +3,7 @@
     "encoding": "base64",
     "size": 5362,
     "name": "labels.yaml",
-    "path": ".github/labels.yaml",
+    "path": ".prowlabels.yaml",
     "content": "YXJlYToKICAtICdidWcnCiAgLSAnaW1wb3J0YW50JwoKa2luZDoKICAtICdmYWlsaW5nLXRlc3QnCiAgLSAnY2xlYW51cCcKCnByaW9yaXR5OgogIC0gJ2xvdycKICAtICdoaWdoJwoKdGVzdHM6CiAgLSAnKiovKi50ZXN0LnRzJwoKc291cmNlOgogIC0gJ3NyYy8qKicK",
     "sha": "3d21ec53a331a6f037a91c368710b99387d012c1",
     "url": "https://api.github.com/repos/octokit/octokit.rb/contents/.github.jpy.wang/labels.yaml",
@@ -15,4 +15,4 @@
       "self": "https://api.github.com/repos/octokit/octokit.rb/contents/.github.jpy.wang/labels.yaml",
       "html": "https://github.com/octokit/octokit.rb/blob/master/.github.jpy.wang/labels.yaml"
     }
-  }
+  }

__tests__/fixtures/labels/labelFileContentsResp.json

@@ -3,7 +3,7 @@
     "encoding": "base64",
     "size": 5362,
     "name": "labels.yaml",
-    "path": ".github/labels.yaml",
+    "path": ".prowlabels.yaml",
     "content": "Cm15LXNwaWN5LWxhYmVsczoKICBhcmVhOgogIC0gJ2J1ZycKICAtICdpbXBvcnRhbnQnCgpraW5kOgogIC0gJ2ZhaWxpbmctdGVzdCcKICAtICdjbGVhbnVwJwoKdGVzdHM6CiAgLSAnX190ZXN0c19fLyonCgpzb3VyY2U6CiAgLSAnc3JjLyonCg==",
     "sha": "3d21ec53a331a6f037a91c368710b99387d012c1",
     "url": "https://api.github.com/repos/octokit/octokit.rb/contents/.github.jpy.wang/labels.yaml",
@@ -15,4 +15,4 @@
       "self": "https://api.github.com/repos/octokit/octokit.rb/contents/.github.jpy.wang/labels.yaml",
       "html": "https://github.com/octokit/octokit.rb/blob/master/.github.jpy.wang/labels.yaml"
     }
-  }
+  }

__tests__/fixtures/labels/labelFileMalformedResponse.json

@@ -35,7 +35,7 @@ describe('area', () => {
 
     server.use(
       rest.get(
-        `${utils.api}/repos/Codertocat/Hello-World/contents/.github%2Flabels.yaml`,
+        `${utils.api}/repos/Codertocat/Hello-World/contents/.prowlabels.yaml`,
         utils.mockResponse(200, labelFileContents)
       )
     )
@@ -61,7 +61,7 @@ describe('area', () => {
 
     server.use(
       rest.get(
-        `${utils.api}/repos/Codertocat/Hello-World/contents/.github%2Flabels.yaml`,
+        `${utils.api}/repos/Codertocat/Hello-World/contents/.prowlabels.yaml`,
         utils.mockResponse(200, labelFileContents)
       )
     )
@@ -73,7 +73,7 @@ describe('area', () => {
     })
   })
 
-  it('only adds area labels for files in .github/labels.yaml', async () => {
+  it('only adds area labels for files in .prowlabels.yaml', async () => {
     issueCommentEvent.comment.body = '/area bug bad important'
     const commentContext = new utils.mockContext(issueCommentEvent)
 
@@ -87,7 +87,7 @@ describe('area', () => {
 
     server.use(
       rest.get(
-        `${utils.api}/repos/Codertocat/Hello-World/contents/.github%2Flabels.yaml`,
+        `${utils.api}/repos/Codertocat/Hello-World/contents/.prowlabels.yaml`,
         utils.mockResponse(200, labelFileContents)
       )
     )

__tests__/label/area.test.ts

@@ -35,7 +35,7 @@ describe('kind', () => {
 
     server.use(
       rest.get(
-        `${utils.api}/repos/Codertocat/Hello-World/contents/.github%2Flabels.yaml`,
+        `${utils.api}/repos/Codertocat/Hello-World/contents/.prowlabels.yaml`,
         utils.mockResponse(200, labelFileContents)
       )
     )
@@ -61,7 +61,7 @@ describe('kind', () => {
 
     server.use(
       rest.get(
-        `${utils.api}/repos/Codertocat/Hello-World/contents/.github%2Flabels.yaml`,
+        `${utils.api}/repos/Codertocat/Hello-World/contents/.prowlabels.yaml`,
         utils.mockResponse(200, labelFileContents)
       )
     )
@@ -73,7 +73,7 @@ describe('kind', () => {
     })
   })
 
-  it('only adds kind labels for files in .github/labels.yaml', async () => {
+  it('only adds kind labels for files in .prowlabels.yaml', async () => {
     issueCommentEvent.comment.body = '/kind cleanup bad failing-test'
     const commentContext = new utils.mockContext(issueCommentEvent)
 
@@ -87,7 +87,7 @@ describe('kind', () => {
 
     server.use(
       rest.get(
-        `${utils.api}/repos/Codertocat/Hello-World/contents/.github%2Flabels.yaml`,
+        `${utils.api}/repos/Codertocat/Hello-World/contents/.prowlabels.yaml`,
         utils.mockResponse(200, labelFileContents)
       )
     )

__tests__/label/kind.test.ts

@@ -35,7 +35,7 @@ describe('priority', () => {
 
     server.use(
       rest.get(
-        `${utils.api}/repos/Codertocat/Hello-World/contents/.github%2Flabels.yaml`,
+        `${utils.api}/repos/Codertocat/Hello-World/contents/.prowlabels.yaml`,
         utils.mockResponse(200, labelFileContents)
       )
     )
@@ -61,7 +61,7 @@ describe('priority', () => {
 
     server.use(
       rest.get(
-        `${utils.api}/repos/Codertocat/Hello-World/contents/.github%2Flabels.yaml`,
+        `${utils.api}/repos/Codertocat/Hello-World/contents/.prowlabels.yaml`,
         utils.mockResponse(200, labelFileContents)
       )
     )
@@ -73,7 +73,7 @@ describe('priority', () => {
     })
   })
 
-  it('only adds priority labels for files in .github/labels.yaml', async () => {
+  it('only adds priority labels for files in .prowlabels.yaml', async () => {
     issueCommentEvent.comment.body = '/priority low mid high'
     const commentContext = new utils.mockContext(issueCommentEvent)
 
@@ -87,7 +87,7 @@ describe('priority', () => {
 
     server.use(
       rest.get(
-        `${utils.api}/repos/Codertocat/Hello-World/contents/.github%2Flabels.yaml`,
+        `${utils.api}/repos/Codertocat/Hello-World/contents/.prowlabels.yaml`,
         utils.mockResponse(200, labelFileContents)
       )
     )

__tests__/label/priority.test.ts

@@ -38,11 +38,11 @@ describe('utils labeling', () => {
 
     server.use(
       rest.get(
-        `${utils.api}/repos/Codertocat/Hello-World/contents/.github%2Flabels.yml`,
+        `${utils.api}/repos/Codertocat/Hello-World/contents/.prowlabels.yml`,
         utils.mockResponse(200, labelFileContents)
       ),
       rest.get(
-        `${utils.api}/repos/Codertocat/Hello-World/contents/.github%2Flabels.yaml`,
+        `${utils.api}/repos/Codertocat/Hello-World/contents/.prowlabels.yaml`,
         utils.mockResponse(404)
       )
     )
@@ -62,11 +62,11 @@ describe('utils labeling', () => {
 
     server.use(
       rest.get(
-        `${utils.api}/repos/Codertocat/Hello-World/contents/.github%2Flabels.yml`,
+        `${utils.api}/repos/Codertocat/Hello-World/contents/.prowlabels.yml`,
         utils.mockResponse(200, malformedFileContents)
       ),
       rest.get(
-        `${utils.api}/repos/Codertocat/Hello-World/contents/.github%2Flabels.yaml`,
+        `${utils.api}/repos/Codertocat/Hello-World/contents/.prowlabels.yaml`,
         utils.mockResponse(404)
       )
     )

__tests__/utils/labeling.test.ts

@@ -238,6 +238,12 @@ const tryMergePr = async (pr, octokit, context = github.context) => {
 
 "use strict";
 
+/**
+ * @deprecated - it's no longer recommended to use the cron labeler for PRs.
+ * As of ~2020, GitHub actions support `pull_request_target` which can be used with
+ * the "actions/labeler" workflow. This supports labeling PRs when they are opened,
+ * even from forks (which this feature attempted to subvert via a cron).
+ */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -2774,7 +2780,7 @@ exports.cancelLabel = exports.addPrefix = exports.removeLabels = exports.getCurr
 const core = __importStar(__nccwpck_require__(2186));
 const yaml = __importStar(__nccwpck_require__(1917));
 /**
- * getArgumentLabels will get the .github/labels.yaml or .github.labels.yml file.
+ * getArgumentLabels will get the .prowlabels.yaml or .prowlabels.yml file.
  * it will then return the section specified by arg.
  *
  * This method has some eslint ignores related to
@@ -2790,18 +2796,18 @@ const getArgumentLabels = async (octokit, context, arg) => {
     try {
         response = await octokit.repos.getContent({
             ...context.repo,
-            path: '.github/labels.yaml'
+            path: '.prowlabels.yaml'
         });
     }
     catch (e) {
         try {
             response = await octokit.repos.getContent({
                 ...context.repo,
-                path: '.github/labels.yml'
+                path: '.prowlabels.yml'
             });
         }
         catch (e2) {
-            throw new Error(`could not get .github/labels.yaml or .github/labels.yml: ${e} ${e2}`);
+            throw new Error(`could not get .prowlabels.yaml or .prowlabels.yml: ${e} ${e2}`);
         }
     }
     if (!response.data.content || !response.data.encoding) {

dist/index.js

@@ -17,13 +17,13 @@ Commands | Policy | Description
 
 Label Commands | Policy | Description
 --- | --- | ---
-`/area [label1 label2 ...]` | anyone | adds an area/<> label(s) if it's defined in [the `.github/labels.yaml` file](./labeling.md)
-`/kind [label1 label2 ...]` | anyone | adds a kind/<> label(s) if it's defined in [the `.github/labels.yaml` file](./labeling.md)
+`/area [label1 label2 ...]` | anyone | adds an area/<> label(s) if it's defined in [the `.prowlabels.yaml` file](./labeling.md)
+`/kind [label1 label2 ...]` | anyone | adds a kind/<> label(s) if it's defined in [the `.prowlabels.yaml` file](./labeling.md)
 `/lgtm` | [OWNERS](#owners) if present, otherwise Collaborators and Org Members | adds the `lgtm` label. This is used for [automatic PR merging]()
 `/lgtm cancel` | [OWNERS](#owners) if present, otherwise Collaborators and Org Members | removes the `lgtm` label
 `/hold` | anyone | adds the `hold` label which prevents [automatic PR merging](./automatic-merging.md). Also see [lgtm removal on pr update](./pr-jobs.md)
 `/hold cancel` | anyone | removes the `hold` label
-`/priority [label1 label2 ...]` | anyone | adds a priority/<> label(s) if it's defined in [the `.github/labels.yaml` file](./automatic-merging.md)
+`/priority [label1 label2 ...]` | anyone | adds a priority/<> label(s) if it's defined in [the `.prowlabels.yaml` file](./automatic-merging.md)
 `/remove [label1 label2 ...]` | Collaborators | removes a specified label(s) on an issue / PR
 
 ## OWNERS

docs/commands.md

@@ -5,14 +5,13 @@ The following jobs are supported through [cron Github workflows]().
 Jobs | Description
 --- | ---
 `lgtm` | Will attempt to automatically merge a PR with the `lgtm` label. Blocked by the `hold` label. Removed by the [lgtm PR job on pr update](./pr-jobs.md)
-`pr-labeler` | Labels PRs with labels based on file globs found in `.github/labels.yaml`. See [docs on PR labeler for more info](pr-labeling.md)
+`pr-labeler` | **(DEPRECATED)** Labels PRs with labels based on file globs found in `.github/labels.yaml`. See [docs on PR labeler for more info](pr-labeling.md)
 
-## PR labeler
-> What is this Chron job PR labeler?
+> What is the Chron job PR labeler?
 
 This job is a legacy feature of Github Prow bot which would label PRs
 based on a chron schedule. This was created since Github at the time did not provide a way
-to securely run actions (and therefore code) from PR forks, which could possibly be untrusted. 
+to securely run actions (and therefore code) from PR forks, which could possibly be untrusted.
 This chron job runs from _the main branch_ and not forks, therefore preventing any
 forked malicious code from being run against the repository.
 
@@ -36,6 +35,7 @@ However, this has some known limitations. The chron labeler queries Github in 10
 This can trigger github to rate limit the bot.
 
 This job may be run with the following workflow configuration:
+
 ```yml
 name: "Label PRs from globs"
 on:

docs/cron-jobs.md

@@ -1,14 +1,15 @@
 # Examples
 
-* [.github/labels.yaml](#githublabelsyaml)
+* [`.prowlabels.yaml`](#prowlabelsyaml)
 * [Review and Approve Pull Requests](#review-and-approve-pull-requests)
 * [All prow github actions](#all-prow-github-actions)
 * [PR Labeler](#pr-labeler)
 * [Automatic PR merger](#automatic-pr-merger)
 * [PR job to remove lgtm label on update](#pr-job-to-remove-lgtm-label-on-update)
 
-### .github/labels.yaml
-A `.github/labels.yaml` file is necessary for most of the labeling commands & jobs
+### `.prowlabels.yaml`
+
+A `.prowlabels.yaml` file is necessary for most of the labeling commands & jobs:
 
 ```yaml
 area:
@@ -23,14 +24,6 @@ priority:
   - 'low'
   - 'mid'
   - 'high'
-
-# File globs for PR labeler
-# refer to github actions/labeler for further documentation
-tests:
-  - '**/*.test.ts'
-
-source:
-  - 'src/**'
 ```
 
 ### Review and Approve Pull Requests