Add test changes

build(deps): bump actions/upload-artifact from 3 to 4

.github/workflows/check-dist.yml

@@ -15,17 +15,22 @@ on:
     paths-ignore:
       - '**.md'
 
+env:
+  # A pipe-separated array of files to ignore when comparing the expected and actual dist/ directories,
+  # which are used as a regular expression filter in the `grep` command.
+  FILES_TO_IGNORE: 'index.js.map|sourcemap-register.js'
+
 jobs:
   check-dist:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - name: Set Node.js 12.x
+      - name: Set Node.js 20.x
         uses: actions/setup-node@v3
         with:
-          node-version: 12.x
+          node-version: 20.x
           cache: npm
 
       - name: Install dependencies
@@ -38,15 +43,23 @@ jobs:
 
       - name: Compare the expected and actual dist/ directories
         run: |
-          if [ "$(git diff --ignore-space-at-eol dist/ | wc -l)" -gt "0" ]; then
-            echo "Detected uncommitted changes after build.  See status below:"
-            git diff
+          # Get a list of files that are different between the checked-in dist/ directory and the generated dist/ directory,
+          # then trim the list to remove any leading or trailing whitespace.
+          CHANGED_FILES=$(git diff --ignore-space-at-eol --name-only dist/ | grep -vE "$FILES_TO_IGNORE" | sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//')
+          if [ -n "$CHANGED_FILES" ]; then
+            echo "❗️ Detected uncommitted changes after build (see diff output below)." >&2
+            echo "This indicates that the dist/ directory is out of sync with the checked-in index.js.\n" >&2
+            echo "⭐️ If the changes below are expected, run 'npm run build:compile && npm run build:package' and commit the output files." >&2
+            # Run `git diff` for each line/file in $CHANGED_FILES:
+            echo "$CHANGED_FILES" | xargs -I {} git diff --ignore-space-at-eol --text -- {}
             exit 1
+          else
+            echo "✅ No uncommitted changes detected after build."
           fi
         id: diff
 
       # If index.js was different than expected, upload the expected version as an artifact
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         if: ${{ failure() && steps.diff.conclusion == 'failure' }}
         with:
           name: dist

.github/workflows/codeql-analysis.yml

@@ -38,11 +38,11 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
+        uses: github/codeql-action/init@v3
         with:
           languages: ${{ matrix.language }}
           # If you wish to specify custom queries, you can do so here or in a config file.
@@ -53,7 +53,7 @@ jobs:
       # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
       # If this step fails, then you should remove it and run the build manually (see below)
       - name: Autobuild
-        uses: github/codeql-action/autobuild@v2
+        uses: github/codeql-action/autobuild@v3
 
       # ℹ️ Command-line programs to run using the OS shell.
       # 📚 https://git.io/JvXDl
@@ -67,4 +67,4 @@ jobs:
       #   make release
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2
+        uses: github/codeql-action/analyze@v3

.github/workflows/licensed.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     name: Check licenses
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - run: npm ci
       - name: Install licensed
         run: |

.github/workflows/test.yml

@@ -13,7 +13,7 @@ jobs:
   build: # make sure build/ci work properly
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - run: |
           npm install
       - run: |

.licenses/npm/@actions/core.dep.yml

@@ -1,5 +1,5 @@
 ---
-name: "@actions/core"
+name: '@actions/core'
 version: 1.10.0
 type: npm
 summary: Actions core lib

.licenses/npm/@actions/github.dep.yml

@@ -1,6 +1,6 @@
 ---
 name: '@actions/github'
-version: 5.0.3
+version: 5.1.1
 type: npm
 summary: Actions github lib
 homepage: https://github.com/actions/toolkit/tree/main/packages/github

README.md

@@ -38,7 +38,7 @@ jobs:
     steps:
       - uses: actions/add-to-project@RELEASE_VERSION
         with:
-          # You can target a repository in a different organization
+          # You can target a project in a different organization
           # to the issue
           project-url: https://github.com/orgs/<orgName>/projects/<projectNumber>
           github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}
@@ -81,7 +81,7 @@ on:
 
 jobs:
   add-to-project:
-    name: Add issue to project
+    name: Add pull request to project
     runs-on: ubuntu-latest
     steps:
       - uses: actions/add-to-project@RELEASE_VERSION
@@ -124,12 +124,14 @@ jobs:
 Currently this action supports the following [`issues` events](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issues):
 
 - `opened`
+- `reopened`
 - `transferred`
 - `labeled`
 
 and the following [`pull_request` events](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request):
 
 - `opened`
+- `reopened`
 - `labeled`
 
 Using these events ensure that a given issue or pull request, in the workflow's repo, is added to the [specified project](#project-url). If [labeled input(s)](#labeled) are defined, then issues will only be added if they contain at least _one_ of the labels in the list.
@@ -137,12 +139,20 @@ Using these events ensure that a given issue or pull request, in the workflow's
 ## Creating a PAT and adding it to your repository
 
 - create a new [personal access
-  token](https://github.com/settings/tokens/new) with `repo` and `project` scopes
+  token](https://github.com/settings/tokens/new) with `project` scope. For private repos you will also need `repo` scope.
   _See [Creating a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) for more information_
 
+  > **NOTE:** ℹ️ Use a classic token with full control of projects. Personal access tokens with fine grained access do not support the GraphQL API.
+
 - add the newly created PAT as a repository secret, this secret will be referenced by the [github-token input](#github-token)
   _See [Encrypted secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) for more information_
 
+## Setting a specific status or column name to the project item
+
+If you want to add an issue to a custom default column in a project (i.e. other than 'Todo'), you can do this directly via the project UI. You don't need to add anything else to your YAML workflow file to get this to work.
+
+Use the [Add To GitHub Projects](https://github.com/marketplace/actions/add-to-github-projects) action to assign newly opened issues to the project. And then in the project UI simply [specify which column to use as the default](https://docs.github.com/en/issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects#configure-built-in-automation)!
+
 ## Development
 
 To get started contributing to this project, clone it and install dependencies.

__tests__/add-to-project.test.ts

@@ -13,7 +13,7 @@ describe('addToProject', () => {
   beforeEach(() => {
     mockGetInput({
       'project-url': 'https://github.com/orgs/actions/projects/1',
-      'github-token': 'gh_token'
+      'github-token': 'gh_token',
     })
 
     outputs = mockSetOutput()
@@ -30,14 +30,14 @@ describe('addToProject', () => {
         number: 1,
         labels: [{name: 'bug'}],
         // eslint-disable-next-line camelcase
-        html_url: 'https://github.com/actions/add-to-project/issues/74'
+        html_url: 'https://github.com/actions/add-to-project/issues/74',
       },
       repository: {
         name: 'add-to-project',
         owner: {
-          login: 'actions'
-        }
-      }
+          login: 'actions',
+        },
+      },
     }
 
     mockGraphQL(
@@ -46,21 +46,21 @@ describe('addToProject', () => {
         return: {
           organization: {
             projectV2: {
-              id: 'project-id'
-            }
-          }
-        }
+              id: 'project-id',
+            },
+          },
+        },
       },
       {
         test: /addProjectV2ItemById/,
         return: {
           addProjectV2ItemById: {
             item: {
-              id: 'project-item-id'
-            }
-          }
-        }
-      }
+              id: 'project-item-id',
+            },
+          },
+        },
+      },
     )
 
     await addToProject()
@@ -74,14 +74,14 @@ describe('addToProject', () => {
         number: 2221,
         labels: [{name: 'bug'}],
         // eslint-disable-next-line camelcase
-        html_url: 'https://github.com/octokit/octokit.js/issues/2221'
+        html_url: 'https://github.com/octokit/octokit.js/issues/2221',
       },
       repository: {
         name: 'octokit.js',
         owner: {
-          login: 'octokit'
-        }
-      }
+          login: 'octokit',
+        },
+      },
     }
 
     mockGraphQL(
@@ -90,21 +90,21 @@ describe('addToProject', () => {
         return: {
           organization: {
             projectV2: {
-              id: 'project-id'
-            }
-          }
-        }
+              id: 'project-id',
+            },
+          },
+        },
       },
       {
         test: /addProjectV2DraftIssue/,
         return: {
           addProjectV2DraftIssue: {
             projectItem: {
-              id: 'project-item-id'
-            }
-          }
-        }
-      }
+              id: 'project-item-id',
+            },
+          },
+        },
+      },
     )
 
     await addToProject()
@@ -116,7 +116,7 @@ describe('addToProject', () => {
     mockGetInput({
       'project-url': 'https://github.com/orgs/actions/projects/1',
       'github-token': 'gh_token',
-      labeled: 'bug, new'
+      labeled: 'bug, new',
     })
 
     github.context.payload = {
@@ -124,14 +124,14 @@ describe('addToProject', () => {
         number: 1,
         labels: [{name: 'bug'}],
         // eslint-disable-next-line camelcase
-        html_url: 'https://github.com/actions/add-to-project/issues/74'
+        html_url: 'https://github.com/actions/add-to-project/issues/74',
       },
       repository: {
         name: 'add-to-project',
         owner: {
-          login: 'actions'
-        }
-      }
+          login: 'actions',
+        },
+      },
     }
 
     mockGraphQL(
@@ -140,21 +140,21 @@ describe('addToProject', () => {
         return: {
           organization: {
             projectV2: {
-              id: 'project-id'
-            }
-          }
-        }
+              id: 'project-id',
+            },
+          },
+        },
       },
       {
         test: /addProjectV2ItemById/,
         return: {
           addProjectV2ItemById: {
             item: {
-              id: 'project-item-id'
-            }
-          }
-        }
-      }
+              id: 'project-item-id',
+            },
+          },
+        },
+      },
     )
 
     await addToProject()
@@ -166,7 +166,7 @@ describe('addToProject', () => {
     mockGetInput({
       'project-url': 'https://github.com/orgs/actions/projects/1',
       'github-token': 'gh_token',
-      labeled: 'bug, new'
+      labeled: 'bug, new',
     })
 
     github.context.payload = {
@@ -175,14 +175,14 @@ describe('addToProject', () => {
         number: 1,
         labels: [{name: 'bug'}],
         // eslint-disable-next-line camelcase
-        html_url: 'https://github.com/actions/add-to-project/pull/136'
+        html_url: 'https://github.com/actions/add-to-project/pull/136',
       },
       repository: {
         name: 'add-to-project',
         owner: {
-          login: 'actions'
-        }
-      }
+          login: 'actions',
+        },
+      },
     }
 
     mockGraphQL(
@@ -191,21 +191,21 @@ describe('addToProject', () => {
         return: {
           organization: {
             projectV2: {
-              id: 'project-id'
-            }
-          }
-        }
+              id: 'project-id',
+            },
+          },
+        },
       },
       {
         test: /addProjectV2ItemById/,
         return: {
           addProjectV2ItemById: {
             item: {
-              id: 'project-item-id'
-            }
-          }
-        }
-      }
+              id: 'project-item-id',
+            },
+          },
+        },
+      },
     )
 
     await addToProject()
@@ -217,7 +217,7 @@ describe('addToProject', () => {
     mockGetInput({
       'project-url': 'https://github.com/orgs/actions/projects/1',
       'github-token': 'gh_token',
-      labeled: 'bug'
+      labeled: 'bug',
     })
 
     github.context.payload = {
@@ -225,14 +225,14 @@ describe('addToProject', () => {
         number: 1,
         labels: [],
         // eslint-disable-next-line camelcase
-        html_url: 'https://github.com/actions/add-to-project/issues/74'
+        html_url: 'https://github.com/actions/add-to-project/issues/74',
       },
       repository: {
         name: 'add-to-project',
         owner: {
-          login: 'actions'
-        }
-      }
+          login: 'actions',
+        },
+      },
     }
 
     const infoSpy = jest.spyOn(core, 'info')
@@ -247,7 +247,7 @@ describe('addToProject', () => {
       'project-url': 'https://github.com/orgs/actions/projects/1',
       'github-token': 'gh_token',
       labeled: 'bug, new',
-      'label-operator': 'AND'
+      'label-operator': 'AND',
     })
 
     github.context.payload = {
@@ -255,14 +255,14 @@ describe('addToProject', () => {
         number: 1,
         labels: [{name: 'bug'}, {name: 'new'}],
         // eslint-disable-next-line camelcase
-        html_url: 'https://github.com/actions/add-to-project/issues/74'
+        html_url: 'https://github.com/actions/add-to-project/issues/74',
       },
       repository: {
         name: 'add-to-project',
         owner: {
-          login: 'actions'
-        }
-      }
+          login: 'actions',
+        },
+      },
     }
 
     mockGraphQL(
@@ -271,21 +271,21 @@ describe('addToProject', () => {
         return: {
           organization: {
             projectV2: {
-              id: 'project-id'
-            }
-          }
-        }
+              id: 'project-id',
+            },
+          },
+        },
       },
       {
         test: /addProjectV2ItemById/,
         return: {
           addProjectV2ItemById: {
             item: {
-              id: 'project-item-id'
-            }
-          }
-        }
-      }
+              id: 'project-item-id',
+            },
+          },
+        },
+      },
     )
 
     await addToProject()
@@ -298,7 +298,7 @@ describe('addToProject', () => {
       'project-url': 'https://github.com/orgs/actions/projects/1',
       'github-token': 'gh_token',
       labeled: 'bug, new',
-      'label-operator': 'AND'
+      'label-operator': 'AND',
     })
 
     github.context.payload = {
@@ -306,14 +306,14 @@ describe('addToProject', () => {
         number: 1,
         labels: [{name: 'bug'}, {name: 'other'}],
         // eslint-disable-next-line camelcase
-        html_url: 'https://github.com/actions/add-to-project/issues/74'
+        html_url: 'https://github.com/actions/add-to-project/issues/74',
       },
       repository: {
         name: 'add-to-project',
         owner: {
-          login: 'actions'
-        }
-      }
+          login: 'actions',
+        },
+      },
     }
 
     const infoSpy = jest.spyOn(core, 'info')
@@ -328,7 +328,7 @@ describe('addToProject', () => {
       'project-url': 'https://github.com/orgs/actions/projects/1',
       'github-token': 'gh_token',
       labeled: 'bug, new',
-      'label-operator': 'NOT'
+      'label-operator': 'NOT',
     })
 
     github.context.payload = {
@@ -336,14 +336,14 @@ describe('addToProject', () => {
         number: 1,
         labels: [{name: 'bug'}],
         // eslint-disable-next-line camelcase
-        html_url: 'https://github.com/actions/add-to-project/issues/74'
+        html_url: 'https://github.com/actions/add-to-project/issues/74',
       },
       repository: {
         name: 'add-to-project',
         owner: {
-          login: 'actions'
-        }
-      }
+          login: 'actions',
+        },
+      },
     }
 
     const infoSpy = jest.spyOn(core, 'info')
@@ -358,7 +358,7 @@ describe('addToProject', () => {
       'project-url': 'https://github.com/orgs/actions/projects/1',
       'github-token': 'gh_token',
       labeled: 'bug, new',
-      'label-operator': 'NOT'
+      'label-operator': 'NOT',
     })
 
     github.context.payload = {
@@ -366,14 +366,14 @@ describe('addToProject', () => {
         number: 1,
         labels: [{name: 'other'}],
         // eslint-disable-next-line camelcase
-        html_url: 'https://github.com/actions/add-to-project/issues/74'
+        html_url: 'https://github.com/actions/add-to-project/issues/74',
       },
       repository: {
         name: 'add-to-project',
         owner: {
-          login: 'actions'
-        }
-      }
+          login: 'actions',
+        },
+      },
     }
 
     mockGraphQL(
@@ -382,21 +382,21 @@ describe('addToProject', () => {
         return: {
           organization: {
             projectV2: {
-              id: 'project-next-id'
-            }
-          }
-        }
+              id: 'project-next-id',
+            },
+          },
+        },
       },
       {
         test: /addProjectV2ItemById/,
         return: {
           addProjectV2ItemById: {
             item: {
-              id: 'project-next-item-id'
-            }
-          }
-        }
-      }
+              id: 'project-next-item-id',
+            },
+          },
+        },
+      },
     )
 
     await addToProject()
@@ -408,7 +408,7 @@ describe('addToProject', () => {
     mockGetInput({
       'project-url': 'https://github.com/orgs/actions/projects/1',
       'github-token': 'gh_token',
-      labeled: 'accessibility,backend,bug'
+      labeled: 'accessibility,backend,bug',
     })
 
     github.context.payload = {
@@ -416,14 +416,14 @@ describe('addToProject', () => {
         number: 1,
         labels: [{name: 'accessibility'}, {name: 'backend'}],
         // eslint-disable-next-line camelcase
-        html_url: 'https://github.com/actions/add-to-project/issues/74'
+        html_url: 'https://github.com/actions/add-to-project/issues/74',
       },
       repository: {
         name: 'add-to-project',
         owner: {
-          login: 'actions'
-        }
-      }
+          login: 'actions',
+        },
+      },
     }
 
     const gqlMock = mockGraphQL(
@@ -432,21 +432,21 @@ describe('addToProject', () => {
         return: {
           organization: {
             projectV2: {
-              id: 'project-id'
-            }
-          }
-        }
+              id: 'project-id',
+            },
+          },
+        },
       },
       {
         test: /addProjectV2ItemById/,
         return: {
           addProjectV2ItemById: {
             item: {
-              id: 'project-item-id'
-            }
-          }
-        }
-      }
+              id: 'project-item-id',
+            },
+          },
+        },
+      },
     )
 
     const infoSpy = jest.spyOn(core, 'info')
@@ -464,7 +464,7 @@ describe('addToProject', () => {
     mockGetInput({
       'project-url': 'https://github.com/orgs/actions/projects/1',
       'github-token': 'gh_token',
-      labeled: 'accessibility, backend, bug'
+      labeled: 'accessibility, backend, bug',
     })
 
     github.context.payload = {
@@ -472,21 +472,21 @@ describe('addToProject', () => {
         number: 1,
         labels: [{name: 'data'}, {name: 'frontend'}, {name: 'improvement'}],
         // eslint-disable-next-line camelcase
-        html_url: 'https://github.com/actions/add-to-project/issues/74'
+        html_url: 'https://github.com/actions/add-to-project/issues/74',
       },
       repository: {
         name: 'add-to-project',
         owner: {
-          login: 'actions'
-        }
-      }
+          login: 'actions',
+        },
+      },
     }
 
     const infoSpy = jest.spyOn(core, 'info')
     const gqlMock = mockGraphQL()
     await addToProject()
     expect(infoSpy).toHaveBeenCalledWith(
-      `Skipping issue 1 because it does not have one of the labels: accessibility, backend, bug`
+      `Skipping issue 1 because it does not have one of the labels: accessibility, backend, bug`,
     )
     expect(gqlMock).not.toHaveBeenCalled()
   })
@@ -495,7 +495,7 @@ describe('addToProject', () => {
     mockGetInput({
       'project-url': 'https://github.com/orgs/actions/projects/1',
       'github-token': 'gh_token',
-      labeled: 'accessibility  ,   backend    ,,  . ,     bug'
+      labeled: 'accessibility  ,   backend    ,,  . ,     bug',
     })
 
     github.context.payload = {
@@ -504,14 +504,14 @@ describe('addToProject', () => {
         labels: [{name: 'accessibility'}, {name: 'backend'}, {name: 'bug'}],
         'label-operator': 'AND',
         // eslint-disable-next-line camelcase
-        html_url: 'https://github.com/actions/add-to-project/issues/74'
+        html_url: 'https://github.com/actions/add-to-project/issues/74',
       },
       repository: {
         name: 'add-to-project',
         owner: {
-          login: 'actions'
-        }
-      }
+          login: 'actions',
+        },
+      },
     }
 
     const gqlMock = mockGraphQL(
@@ -520,21 +520,21 @@ describe('addToProject', () => {
         return: {
           organization: {
             projectV2: {
-              id: 'project-id'
-            }
-          }
-        }
+              id: 'project-id',
+            },
+          },
+        },
       },
       {
         test: /addProjectV2ItemById/,
         return: {
           addProjectV2ItemById: {
             item: {
-              id: 'project-item-id'
-            }
-          }
-        }
-      }
+              id: 'project-item-id',
+            },
+          },
+        },
+      },
     )
 
     const infoSpy = jest.spyOn(core, 'info')
@@ -551,7 +551,7 @@ describe('addToProject', () => {
   test(`throws an error when url isn't a valid project url`, async () => {
     mockGetInput({
       'project-url': 'https://github.com/orgs/github/repositories',
-      'github-token': 'gh_token'
+      'github-token': 'gh_token',
     })
 
     github.context.payload = {
@@ -559,182 +559,39 @@ describe('addToProject', () => {
         number: 1,
         labels: [],
         // eslint-disable-next-line camelcase
-        html_url: 'https://github.com/actions/add-to-project/issues/74'
+        html_url: 'https://github.com/actions/add-to-project/issues/74',
       },
       repository: {
         name: 'add-to-project',
         owner: {
-          login: 'actions'
-        }
-      }
+          login: 'actions',
+        },
+      },
     }
 
     const infoSpy = jest.spyOn(core, 'info')
     const gqlMock = mockGraphQL()
     await expect(addToProject()).rejects.toThrow(
-      'https://github.com/orgs/github/repositories. Project URL should match the format https://github.com/<orgs-or-users>/<ownerName>/projects/<projectNumber>'
+      'Invalid project URL: https://github.com/orgs/github/repositories. Project URL should match the format <GitHub server domain name>/<orgs-or-users>/<ownerName>/projects/<projectNumber>',
     )
     expect(infoSpy).not.toHaveBeenCalled()
     expect(gqlMock).not.toHaveBeenCalled()
   })
 
-  test(`throws an error when url isn't under the github.com domain`, async () => {
-    mockGetInput({
-      'project-url': 'https://notgithub.com/orgs/github/projects/1',
-      'github-token': 'gh_token'
-    })
-
-    github.context.payload = {
-      issue: {
-        number: 1,
-        labels: [],
-        // eslint-disable-next-line camelcase
-        html_url: 'https://github.com/actions/add-to-project/issues/74'
-      },
-      repository: {
-        name: 'add-to-project',
-        owner: {
-          login: 'actions'
-        }
-      }
-    }
-
-    const infoSpy = jest.spyOn(core, 'info')
-    const gqlMock = mockGraphQL()
-    await expect(addToProject()).rejects.toThrow(
-      'https://notgithub.com/orgs/github/projects/1. Project URL should match the format https://github.com/<orgs-or-users>/<ownerName>/projects/<projectNumber>'
-    )
-    expect(infoSpy).not.toHaveBeenCalled()
-    expect(gqlMock).not.toHaveBeenCalled()
-  })
-
-  test('constructs the correct graphQL query given an organization owner', async () => {
-    mockGetInput({
-      'project-url': 'https://github.com/orgs/actions/projects/1',
-      'github-token': 'gh_token',
-      labeled: 'bug, new'
-    })
-
+  test(`works with URLs that are not under the github.com domain`, async () => {
     github.context.payload = {
       issue: {
         number: 1,
         labels: [{name: 'bug'}],
         // eslint-disable-next-line camelcase
-        html_url: 'https://github.com/actions/add-to-project/issues/74'
+        html_url: 'https://notgithub.com/actions/add-to-project/issues/74',
       },
       repository: {
         name: 'add-to-project',
         owner: {
-          login: 'actions'
-        }
-      }
-    }
-
-    const gqlMock = mockGraphQL(
-      {
-        test: /getProject/,
-        return: {
-          organization: {
-            projectV2: {
-              id: 'project-id'
-            }
-          }
-        }
+          login: 'actions',
         },
-      {
-        test: /addProjectV2ItemById/,
-        return: {
-          addProjectV2ItemById: {
-            item: {
-              id: 'project-item-id'
-            }
-          }
-        }
-      }
-    )
-
-    await addToProject()
-
-    expect(gqlMock).toHaveBeenNthCalledWith(1, expect.stringContaining('organization(login: $projectOwnerName)'), {
-      projectOwnerName: 'actions',
-      projectNumber: 1
-    })
-  })
-
-  test('constructs the correct graphQL query given a user owner', async () => {
-    mockGetInput({
-      'project-url': 'https://github.com/users/monalisa/projects/1',
-      'github-token': 'gh_token',
-      labeled: 'bug, new'
-    })
-
-    github.context.payload = {
-      issue: {
-        number: 1,
-        labels: [{name: 'bug'}],
-        // eslint-disable-next-line camelcase
-        html_url: 'https://github.com/monalisa/add-to-project/issues/74'
       },
-      repository: {
-        name: 'add-to-project',
-        owner: {
-          login: 'monalisa'
-        }
-      }
-    }
-
-    const gqlMock = mockGraphQL(
-      {
-        test: /getProject/,
-        return: {
-          organization: {
-            projectV2: {
-              id: 'project-id'
-            }
-          }
-        }
-      },
-      {
-        test: /addProjectV2ItemById/,
-        return: {
-          addProjectV2ItemById: {
-            item: {
-              id: 'project-item-id'
-            }
-          }
-        }
-      }
-    )
-
-    await addToProject()
-
-    expect(gqlMock).toHaveBeenNthCalledWith(1, expect.stringContaining('user(login: $projectOwnerName)'), {
-      projectOwnerName: 'monalisa',
-      projectNumber: 1
-    })
-  })
-
-  test('compares labels case-insensitively', async () => {
-    mockGetInput({
-      'project-url': 'https://github.com/orgs/actions/projects/1',
-      'github-token': 'gh_token',
-      labeled: 'FOO, Bar, baz',
-      'label-operator': 'AND'
-    })
-
-    github.context.payload = {
-      issue: {
-        number: 1,
-        labels: [{name: 'foo'}, {name: 'BAR'}, {name: 'baz'}],
-        // eslint-disable-next-line camelcase
-        html_url: 'https://github.com/actions/add-to-project/issues/74'
-      },
-      repository: {
-        name: 'add-to-project',
-        owner: {
-          login: 'actions'
-        }
-      }
     }
 
     mockGraphQL(
@@ -743,21 +600,178 @@ describe('addToProject', () => {
         return: {
           organization: {
             projectV2: {
-              id: 'project-next-id'
-            }
-          }
-        }
+              id: 'project-id',
+            },
+          },
+        },
       },
       {
         test: /addProjectV2ItemById/,
         return: {
           addProjectV2ItemById: {
             item: {
-              id: 'project-next-item-id'
-            }
+              id: 'project-item-id',
+            },
+          },
+        },
+      },
+    )
+
+    await addToProject()
+
+    expect(outputs.itemId).toEqual('project-item-id')
+  })
+
+  test('constructs the correct graphQL query given an organization owner', async () => {
+    mockGetInput({
+      'project-url': 'https://github.com/orgs/actions/projects/1',
+      'github-token': 'gh_token',
+      labeled: 'bug, new',
+    })
+
+    github.context.payload = {
+      issue: {
+        number: 1,
+        labels: [{name: 'bug'}],
+        // eslint-disable-next-line camelcase
+        html_url: 'https://github.com/actions/add-to-project/issues/74',
+      },
+      repository: {
+        name: 'add-to-project',
+        owner: {
+          login: 'actions',
+        },
+      },
     }
+
+    const gqlMock = mockGraphQL(
+      {
+        test: /getProject/,
+        return: {
+          organization: {
+            projectV2: {
+              id: 'project-id',
+            },
+          },
+        },
+      },
+      {
+        test: /addProjectV2ItemById/,
+        return: {
+          addProjectV2ItemById: {
+            item: {
+              id: 'project-item-id',
+            },
+          },
+        },
+      },
+    )
+
+    await addToProject()
+
+    expect(gqlMock).toHaveBeenNthCalledWith(1, expect.stringContaining('organization(login: $projectOwnerName)'), {
+      projectOwnerName: 'actions',
+      projectNumber: 1,
+    })
+  })
+
+  test('constructs the correct graphQL query given a user owner', async () => {
+    mockGetInput({
+      'project-url': 'https://github.com/users/monalisa/projects/1',
+      'github-token': 'gh_token',
+      labeled: 'bug, new',
+    })
+
+    github.context.payload = {
+      issue: {
+        number: 1,
+        labels: [{name: 'bug'}],
+        // eslint-disable-next-line camelcase
+        html_url: 'https://github.com/monalisa/add-to-project/issues/74',
+      },
+      repository: {
+        name: 'add-to-project',
+        owner: {
+          login: 'monalisa',
+        },
+      },
     }
+
+    const gqlMock = mockGraphQL(
+      {
+        test: /getProject/,
+        return: {
+          organization: {
+            projectV2: {
+              id: 'project-id',
+            },
+          },
+        },
+      },
+      {
+        test: /addProjectV2ItemById/,
+        return: {
+          addProjectV2ItemById: {
+            item: {
+              id: 'project-item-id',
+            },
+          },
+        },
+      },
+    )
+
+    await addToProject()
+
+    expect(gqlMock).toHaveBeenNthCalledWith(1, expect.stringContaining('user(login: $projectOwnerName)'), {
+      projectOwnerName: 'monalisa',
+      projectNumber: 1,
+    })
+  })
+
+  test('compares labels case-insensitively', async () => {
+    mockGetInput({
+      'project-url': 'https://github.com/orgs/actions/projects/1',
+      'github-token': 'gh_token',
+      labeled: 'FOO, Bar, baz',
+      'label-operator': 'AND',
+    })
+
+    github.context.payload = {
+      issue: {
+        number: 1,
+        labels: [{name: 'foo'}, {name: 'BAR'}, {name: 'baz'}],
+        // eslint-disable-next-line camelcase
+        html_url: 'https://github.com/actions/add-to-project/issues/74',
+      },
+      repository: {
+        name: 'add-to-project',
+        owner: {
+          login: 'actions',
+        },
+      },
     }
+
+    mockGraphQL(
+      {
+        test: /getProject/,
+        return: {
+          organization: {
+            projectV2: {
+              id: 'project-next-id',
+            },
+          },
+        },
+      },
+      {
+        test: /addProjectV2ItemById/,
+        return: {
+          addProjectV2ItemById: {
+            item: {
+              id: 'project-next-item-id',
+            },
+          },
+        },
+      },
     )
 
     await addToProject()
@@ -810,7 +824,7 @@ function mockGraphQL(...mocks: {test: RegExp; return: unknown}[]): jest.Mock {
 
   jest.spyOn(github, 'getOctokit').mockImplementation(() => {
     return {
-      graphql: mock
+      graphql: mock,
     } as unknown as ReturnType<typeof github.getOctokit>
   })
 

action.yml

@@ -3,6 +3,7 @@ description: Automatically add issues and PRs to GitHub projects
 author: GitHub
 branding:
   icon: table
+  color: white
 inputs:
   project-url:
     required: true
@@ -16,6 +17,9 @@ inputs:
   label-operator:
     required: false
     description: The behavior of the labels filter, AND to match all labels, OR to match any label, NOT to exclude any listed label (default is OR)
+outputs:
+  itemId:
+    description: The ID of the item that was added to the project
 runs:
-  using: 'node16'
+  using: 'node20'
   main: 'dist/index.js'

dist/index.js

@@ -42,9 +42,7 @@ Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.mustGetOwnerTypeQuery = exports.addToProject = void 0;
 const core = __importStar(__nccwpck_require__(2186));
 const github = __importStar(__nccwpck_require__(5438));
-// TODO: Ensure this (and the Octokit client) works for non-github.com URLs, as well.
-// https://github.com/orgs|users/<ownerName>/projects/<projectNumber>
-const urlParse = /^(?:https:\/\/)?github\.com\/(?<ownerType>orgs|users)\/(?<ownerName>[^/]+)\/projects\/(?<projectNumber>\d+)/;
+const urlParse = /\/(?<ownerType>orgs|users)\/(?<ownerName>[^/]+)\/projects\/(?<projectNumber>\d+)/;
 function addToProject() {
     var _a, _b, _c, _d, _e, _f, _g, _h, _j;
     return __awaiter(this, void 0, void 0, function* () {
@@ -61,6 +59,7 @@ function addToProject() {
         const issueLabels = ((_c = issue === null || issue === void 0 ? void 0 : issue.labels) !== null && _c !== void 0 ? _c : []).map((l) => l.name.toLowerCase());
         const issueOwnerName = (_d = github.context.payload.repository) === null || _d === void 0 ? void 0 : _d.owner.login;
         core.debug(`Issue/PR owner: ${issueOwnerName}`);
+        core.debug(`Issue/PR labels: ${issueLabels.join(', ')}`);
         // Ensure the issue matches our `labeled` filter based on the label-operator.
         if (labelOperator === 'and') {
             if (!labeled.every(l => issueLabels.includes(l))) {
@@ -83,7 +82,7 @@ function addToProject() {
         core.debug(`Project URL: ${projectUrl}`);
         const urlMatch = projectUrl.match(urlParse);
         if (!urlMatch) {
-            throw new Error(`Invalid project URL: ${projectUrl}. Project URL should match the format https://github.com/<orgs-or-users>/<ownerName>/projects/<projectNumber>`);
+            throw new Error(`Invalid project URL: ${projectUrl}. Project URL should match the format <GitHub server domain name>/<orgs-or-users>/<ownerName>/projects/<projectNumber>`);
         }
         const projectOwnerName = (_e = urlMatch.groups) === null || _e === void 0 ? void 0 : _e.ownerName;
         const projectNumber = parseInt((_g = (_f = urlMatch.groups) === null || _f === void 0 ? void 0 : _f.projectNumber) !== null && _g !== void 0 ? _g : '', 10);
@@ -101,7 +100,7 @@ function addToProject() {
       }
     }`, {
             projectOwnerName,
-            projectNumber
+            projectNumber,
         });
         const projectId = (_j = idResp[ownerTypeQuery]) === null || _j === void 0 ? void 0 : _j.projectV2.id;
         const contentId = issue === null || issue === void 0 ? void 0 : issue.node_id;
@@ -121,8 +120,8 @@ function addToProject() {
       }`, {
                 input: {
                     projectId,
-                    contentId
-                }
+                    contentId,
+                },
             });
             core.setOutput('itemId', addResp.addProjectV2ItemById.item.id);
         }
@@ -139,7 +138,7 @@ function addToProject() {
         }
       }`, {
                 projectId,
-                title: issue === null || issue === void 0 ? void 0 : issue.html_url
+                title: issue === null || issue === void 0 ? void 0 : issue.html_url,
             });
             core.setOutput('itemId', addResp.addProjectV2DraftIssue.projectItem.id);
         }
@@ -1290,8 +1289,9 @@ exports.context = new Context.Context();
  * @param     token    the repo PAT or GITHUB_TOKEN
  * @param     options  other options to set
  */
-function getOctokit(token, options) {
-    return new utils_1.GitHub(utils_1.getOctokitOptions(token, options));
+function getOctokit(token, options, ...additionalPlugins) {
+    const GitHubWithPlugins = utils_1.GitHub.plugin(...additionalPlugins);
+    return new GitHubWithPlugins(utils_1.getOctokitOptions(token, options));
 }
 exports.getOctokit = getOctokit;
 //# sourceMappingURL=github.js.map
@@ -1373,7 +1373,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.getOctokitOptions = exports.GitHub = exports.context = void 0;
+exports.getOctokitOptions = exports.GitHub = exports.defaults = exports.context = void 0;
 const Context = __importStar(__nccwpck_require__(4087));
 const Utils = __importStar(__nccwpck_require__(7914));
 // octokit + plugins
@@ -1382,13 +1382,13 @@ const plugin_rest_endpoint_methods_1 = __nccwpck_require__(3044);
 const plugin_paginate_rest_1 = __nccwpck_require__(4193);
 exports.context = new Context.Context();
 const baseUrl = Utils.getApiBaseUrl();
-const defaults = {
+exports.defaults = {
     baseUrl,
     request: {
         agent: Utils.getProxyAgent(baseUrl)
     }
 };
-exports.GitHub = core_1.Octokit.plugin(plugin_rest_endpoint_methods_1.restEndpointMethods, plugin_paginate_rest_1.paginateRest).defaults(defaults);
+exports.GitHub = core_1.Octokit.plugin(plugin_rest_endpoint_methods_1.restEndpointMethods, plugin_paginate_rest_1.paginateRest).defaults(exports.defaults);
 /**
  * Convience function to correctly format Octokit Options to pass into the constructor.
  *

jest.config.js

@@ -3,7 +3,7 @@ module.exports = {
   moduleFileExtensions: ['js', 'ts'],
   testMatch: ['**/*.test.ts'],
   transform: {
-    '^.+\\.ts$': 'ts-jest'
+    '^.+\\.ts$': 'ts-jest',
   },
-  verbose: true
+  verbose: true,
 }

package.json

@@ -5,27 +5,28 @@
   "author": "GitHub and contributors",
   "dependencies": {
     "@actions/core": "^1.10.0",
-    "@actions/github": "^5.0.3"
+    "@actions/github": "^5.1.1"
   },
   "engines": {
-    "node": ">=16.0.0 <17.0.0",
-    "npm": ">= 7.0.0"
+    "node": ">=16.0.0",
+    "npm": ">= 8.0.0"
   },
   "devDependencies": {
-    "@github/prettier-config": "^0.0.4",
-    "@types/jest": "^27.5.0",
-    "@types/node": "~16.18.3",
-    "@typescript-eslint/parser": "^5.42.0",
-    "@vercel/ncc": "^0.34.0",
-    "concurrently": "^7.5.0",
-    "eslint": "^8.26.0",
-    "eslint-plugin-github": "^4.4.0",
-    "eslint-plugin-jest": "^27.1.3",
-    "eslint-plugin-prettier": "^4.2.1",
-    "jest": "^27.5.1",
-    "prettier": "2.7.1",
-    "ts-jest": "^27.1.4",
-    "typescript": "^4.8.4"
+    "@github/prettier-config": "^0.0.6",
+    "@types/jest": "^29.5.7",
+    "@types/node": "16.18.60",
+    "@typescript-eslint/parser": "^6.9.1",
+    "@typescript-eslint/eslint-plugin": "^6.7.0",
+    "@vercel/ncc": "^0.38.0",
+    "concurrently": "^8.2.2",
+    "eslint": "^8.57.0",
+    "eslint-plugin-github": "^4.10.0",
+    "eslint-plugin-jest": "^27.6.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "jest": "^29.7.0",
+    "prettier": "3.0.3",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.2.2"
   },
   "keywords": [
     "actions",

src/add-to-project.ts

@@ -1,10 +1,7 @@
 import * as core from '@actions/core'
 import * as github from '@actions/github'
 
-// TODO: Ensure this (and the Octokit client) works for non-github.com URLs, as well.
-// https://github.com/orgs|users/<ownerName>/projects/<projectNumber>
-const urlParse =
-  /^(?:https:\/\/)?github\.com\/(?<ownerType>orgs|users)\/(?<ownerName>[^/]+)\/projects\/(?<projectNumber>\d+)/
+const urlParse = /\/(?<ownerType>orgs|users)\/(?<ownerName>[^/]+)\/projects\/(?<projectNumber>\d+)/
 
 interface ProjectNodeIDResponse {
   organization?: {
@@ -54,6 +51,7 @@ export async function addToProject(): Promise<void> {
   const issueOwnerName = github.context.payload.repository?.owner.login
 
   core.debug(`Issue/PR owner: ${issueOwnerName}`)
+  core.debug(`Issue/PR labels: ${issueLabels.join(', ')}`)
 
   // Ensure the issue matches our `labeled` filter based on the label-operator.
   if (labelOperator === 'and') {
@@ -79,7 +77,7 @@ export async function addToProject(): Promise<void> {
 
   if (!urlMatch) {
     throw new Error(
-      `Invalid project URL: ${projectUrl}. Project URL should match the format https://github.com/<orgs-or-users>/<ownerName>/projects/<projectNumber>`
+      `Invalid project URL: ${projectUrl}. Project URL should match the format <GitHub server domain name>/<orgs-or-users>/<ownerName>/projects/<projectNumber>`,
     )
   }
 
@@ -103,8 +101,8 @@ export async function addToProject(): Promise<void> {
     }`,
     {
       projectOwnerName,
-      projectNumber
-    }
+      projectNumber,
+    },
   )
 
   const projectId = idResp[ownerTypeQuery]?.projectV2.id
@@ -119,6 +117,11 @@ export async function addToProject(): Promise<void> {
   if (issueOwnerName === projectOwnerName) {
     core.info('Creating project item')
 
+    if (issueOwnerName === 'github') {
+      console.log('this is a test')
+      throw new Error('test')
+    }
+
     const addResp = await octokit.graphql<ProjectAddItemResponse>(
       `mutation addIssueToProject($input: AddProjectV2ItemByIdInput!) {
         addProjectV2ItemById(input: $input) {
@@ -130,9 +133,9 @@ export async function addToProject(): Promise<void> {
       {
         input: {
           projectId,
-          contentId
-        }
-      }
+          contentId,
+        },
+      },
     )
 
     core.setOutput('itemId', addResp.addProjectV2ItemById.item.id)
@@ -152,8 +155,8 @@ export async function addToProject(): Promise<void> {
       }`,
       {
         projectId,
-        title: issue?.html_url
-      }
+        title: issue?.html_url,
+      },
     )
 
     core.setOutput('itemId', addResp.addProjectV2DraftIssue.projectItem.id)

tsconfig.json

@@ -1,12 +1,14 @@
 {
   "compilerOptions": {
-    "target": "es6" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */,
+    "target": "ES2015" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */,
     "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
     "outDir": "./lib" /* Redirect output structure to the directory. */,
     "rootDir": "./src" /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */,
     "strict": true /* Enable all strict type-checking options. */,
     "noImplicitAny": true /* Raise error on expressions and declarations with an implied 'any' type. */,
-    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
+    "noUncheckedIndexedAccess": true,
+    "lib": ["ES2015"]
   },
   "exclude": ["node_modules", "**/*.test.ts"]
 }