Merge pull request #338 from saravanan30erd/fix-url-match

Allow projects outside github.com
actions · Apr 3, 2023 · 31b3f3c · 31b3f3c
2 parents 5b64707 + 039f00e
commit 31b3f3c
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 25 deletions.
diff --git a/__tests__/add-to-project.test.ts b/__tests__/add-to-project.test.ts
@@ -572,24 +572,19 @@ describe('addToProject', () => {
     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',
-    })
-
+  test(`works with URLs that are not under the github.com domain`, async () => {
     github.context.payload = {
       issue: {
         number: 1,
-        labels: [],
+        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',
@@ -599,13 +594,32 @@ describe('addToProject', () => {
       },
     }
 
-    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>',
+    mockGraphQL(
+      {
+        test: /getProject/,
+        return: {
+          organization: {
+            projectV2: {
+              id: 'project-id',
+            },
+          },
+        },
+      },
+      {
+        test: /addProjectV2ItemById/,
+        return: {
+          addProjectV2ItemById: {
+            item: {
+              id: 'project-item-id',
+            },
+          },
+        },
+      },
     )
-    expect(infoSpy).not.toHaveBeenCalled()
-    expect(gqlMock).not.toHaveBeenCalled()
+
+    await addToProject()
+
+    expect(outputs.itemId).toEqual('project-item-id')
   })
 
   test('constructs the correct graphQL query given an organization owner', async () => {

diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/add-to-project.ts b/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?: {
@@ -80,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>`,
     )
   }