Get Project V2 field

README.md

@@ -20,6 +20,7 @@ TODO
   _eg: `https://github.com/orgs|users/<ownerName>/projects/<projectNumber>`_
 - `github-token` **(required)** is a [personal access
   token](https://github.com/settings/tokens/new) with `repo` and `project` scopes.
+- `field-name` **(required)** is a field name of the project v2 item to update.
 
 ## Outputs
 

__tests__/ex-octokit/index.test.ts

@@ -8,7 +8,7 @@ describe('fetchProjectV2Id', () => {
 
   it('fetches ProjectV2 ID from organization', async () => {
     mockGraphQL({
-      test: /getProject/,
+      test: /fetchProjectV2Id/,
       return: {
         organization: {
           projectV2: {
@@ -30,7 +30,7 @@ describe('fetchProjectV2Id', () => {
 
   it('fetches ProjectV2 ID from user', async () => {
     mockGraphQL({
-      test: /getProject/,
+      test: /fetchProjectV2Id/,
       return: {
         user: {
           projectV2: {
@@ -47,6 +47,82 @@ describe('fetchProjectV2Id', () => {
   })
 })
 
+describe('fetchProjectV2FieldByName', () => {
+  afterEach(() => {
+    jest.restoreAllMocks()
+  })
+
+  it('fetches field on ProjectV2Field', async () => {
+    mockGraphQL({
+      test: /fetchProjectV2FieldByName/,
+      return: {
+        node: {
+          field: {
+            __typename: 'ProjectV2Field',
+            id: 'field-id',
+            name: 'text-field',
+            dataType: 'TEXT'
+          }
+        }
+      }
+    })
+
+    const exOctokit = new ExOctokit('gh_token')
+    const projectV2Field = await exOctokit.fetchProjectV2FieldByName(
+      'project-id',
+      'text-field'
+    )
+
+    expect(projectV2Field).toEqual({
+      __typename: 'ProjectV2Field',
+      id: 'field-id',
+      name: 'text-field',
+      dataType: 'TEXT'
+    })
+  })
+
+  it('fetches field on ProjectV2SingleSelectField', async () => {
+    mockGraphQL({
+      test: /fetchProjectV2FieldByName/,
+      return: {
+        node: {
+          field: {
+            __typename: 'ProjectV2SingleSelectField',
+            id: 'field-id',
+            name: 'select-field',
+            dataType: 'SINGLE_SELECT',
+            options: [
+              {
+                id: 'option-id',
+                name: 'option-name'
+              }
+            ]
+          }
+        }
+      }
+    })
+
+    const exOctokit = new ExOctokit('gh_token')
+    const projectV2Field = await exOctokit.fetchProjectV2FieldByName(
+      'project-id',
+      'select-field'
+    )
+
+    expect(projectV2Field).toEqual({
+      __typename: 'ProjectV2SingleSelectField',
+      id: 'field-id',
+      name: 'select-field',
+      dataType: 'SINGLE_SELECT',
+      options: [
+        {
+          id: 'option-id',
+          name: 'option-name'
+        }
+      ]
+    })
+  })
+})
+
 function mockGraphQL(...mocks: { test: RegExp; return: unknown }[]): jest.Mock {
   const mock = jest.fn().mockImplementation((query: string) => {
     const match = mocks.find(m => m.test.test(query))

__tests__/update-project-v2-item-field.test.ts

@@ -6,6 +6,7 @@ import { ExOctokit } from '../src/ex-octokit'
 
 describe('updateProjectV2ItemField', () => {
   let outputs: Record<string, string>
+  let debug: jest.SpyInstance
 
   beforeEach(() => {
     jest.spyOn(process.stdout, 'write').mockImplementation(() => true)
@@ -17,6 +18,7 @@ describe('updateProjectV2ItemField', () => {
       'github-token': 'gh_token'
     })
 
+    debug = mockDebug()
     outputs = mockSetOutput()
   })
 
@@ -42,9 +44,12 @@ describe('updateProjectV2ItemField', () => {
     }
 
     mockFetchProjectV2Id().mockResolvedValue('project-id')
+    mockFetchProjectV2FieldByName().mockResolvedValue({ id: 'field-id' })
 
     await updateProjectV2ItemField()
 
+    expect(debug).toHaveBeenCalledWith('ProjectV2 ID: project-id')
+    expect(debug).toHaveBeenCalledWith('Field ID: field-id')
     expect(outputs.projectV2Id).toEqual('project-id')
   })
 
@@ -95,9 +100,12 @@ describe('updateProjectV2ItemField', () => {
     }
 
     mockFetchProjectV2Id().mockResolvedValue('project-id')
+    mockFetchProjectV2FieldByName().mockResolvedValue({ id: 'field-id' })
 
     await updateProjectV2ItemField()
 
+    expect(debug).toHaveBeenCalledWith('ProjectV2 ID: project-id')
+    expect(debug).toHaveBeenCalledWith('Field ID: field-id')
     expect(outputs.projectV2Id).toEqual('project-id')
   })
 })
@@ -115,6 +123,14 @@ function mockSetOutput(): Record<string, string> {
   return output
 }
 
+function mockDebug(): jest.SpyInstance {
+  return jest.spyOn(core, 'debug').mockImplementation()
+}
+
 function mockFetchProjectV2Id(): jest.SpyInstance {
   return jest.spyOn(ExOctokit.prototype, 'fetchProjectV2Id')
 }
+
+function mockFetchProjectV2FieldByName(): jest.SpyInstance {
+  return jest.spyOn(ExOctokit.prototype, 'fetchProjectV2FieldByName')
+}

action.yml

@@ -10,6 +10,9 @@ inputs:
   github-token:
     required: true
     description: A GitHub personal access token with write access to the project
+  field-name:
+    required: true
+    description: The name of the field to update
 
 outputs:
   projectId:

src/ex-octokit/index.ts

@@ -14,6 +14,24 @@ interface ProjectV2IdResponse {
   }
 }
 
+interface ProjectV2FieldResponse {
+  node: {
+    field: ProjectV2Field | null
+  } | null
+}
+
+interface ProjectV2Field {
+  __typename: 'ProjectV2Field' | 'ProjectV2SingleSelectField'
+  id: string
+  name: string
+  dataType: string
+
+  options?: {
+    id: string
+    name: string
+  }[]
+}
+
 export class ExOctokit {
   octokit: ReturnType<typeof getOctokit>
 
@@ -27,7 +45,7 @@ export class ExOctokit {
     projectNumber: number
   ): Promise<string | undefined> {
     const projectV2IdResponse = await this.octokit.graphql<ProjectV2IdResponse>(
-      `query getProject($projectOwnerName: String!, $projectNumber: Int!) {
+      `query fetchProjectV2Id($projectOwnerName: String!, $projectNumber: Int!) {
         ${ownerTypeQuery}(login: $projectOwnerName) {
           projectV2(number: $projectNumber) {
             id
@@ -42,4 +60,43 @@ export class ExOctokit {
 
     return projectV2IdResponse[ownerTypeQuery]?.projectV2.id
   }
+
+  // TODO: support 'ProjectV2IterationField' Type
+  async fetchProjectV2FieldByName(
+    projectV2Id: string,
+    fieldName: string
+  ): Promise<ProjectV2Field | null | undefined> {
+    const projectV2FieldResponse =
+      await this.octokit.graphql<ProjectV2FieldResponse>(
+        `query fetchProjectV2FieldByName($projectOwnerName: String!, $fieldName: Int!) {
+          node(id: $projectV2Id) {
+            ... on ProjectV2 {
+              field(name: $fieldName) {
+                __typename
+                ... on ProjectV2Field {
+                  id
+                  name
+                  dataType
+                }
+                ... on ProjectV2SingleSelectField {
+                  id
+                  name
+                  dataType
+                  options {
+                    id
+                    name
+                  }
+                }
+              }
+            }
+          }
+        }`,
+        {
+          projectV2Id,
+          fieldName
+        }
+      )
+
+    return projectV2FieldResponse.node?.field
+  }
 }

src/update-project-v2-item-field.ts

@@ -10,6 +10,7 @@ export async function updateProjectV2ItemField(): Promise<void> {
   // Get the action inputs
   const projectUrl = core.getInput('project-url', { required: true })
   const ghToken = core.getInput('github-token', { required: true })
+  const fieldName = core.getInput('field-name', { required: true })
 
   // Get the issue/PR owner name and node ID from payload
   const issue =
@@ -40,9 +41,21 @@ export async function updateProjectV2ItemField(): Promise<void> {
     projectOwnerName,
     projectNumber
   )
+  if (!projectV2Id) {
+    throw new Error(`ProjectV2 ID is undefined`)
+  }
+
   const contentId = issue?.node_id
 
+  // Fetch the field node ID
+  const field = await exOctokit.fetchProjectV2FieldByName(
+    projectV2Id,
+    fieldName
+  )
+  const fieldId = field?.id
+
   core.debug(`ProjectV2 ID: ${projectV2Id}`)
+  core.debug(`Field ID: ${fieldId}`)
   core.debug(`Content ID: ${contentId}`)
 
   // Set outputs for other workflow steps to use