Fix "Item not found with ID" error for assigned trigger by adding auto_add parameter

README.md

@@ -53,6 +53,33 @@ jobs:
 
 *Note: The above step can be repeated multiple times in a given job to update multiple fields on the same or different projects.* 
 
+#### Example: Update project status when issue is assigned
+
+When using the `issues` trigger with `assigned` event, you may want to automatically add the issue to a project and set its status:
+
+```yml
+name: Update assigned issues in project
+
+on:
+ issues:
+ types: [assigned]
+
+jobs:
+ update-project-status:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Update status
+ uses: github/update-project-action@v2
+ with:
+ github_token: ${{ secrets.ACTIONS_TOKEN }}
+ organization: webrecorder
+ project_number: 9
+ content_id: ${{ github.event.issue.node_id }}
+ field: Status
+ value: Todo
+ auto_add: true # Automatically add issue to project if not already in it
+```
+
 ### Roadmap
 
 The Action is largely feature complete with regards to its initial goals. Find a bug or have a feature request? [Open an issue](https://github.com/benbalter/update-project-action/issues), or better yet, submit a pull request - contribution welcome!
@@ -66,6 +93,7 @@ The Action is largely feature complete with regards to its initial goals. Find a
 * `organization` - The organization that contains the project, defaults to the current repository owner
 * `project_number` - The project number from the project's URL
 * `value` - The value to set the project field to. Only required for operation type read
+* `auto_add` - Automatically add the issue or pull request to the project if it's not already in it (default: false)
 
 ### Outputs
 

__test__/main.test.ts

@@ -28,23 +28,23 @@ test("valueGraphqlType returns String for text", () => {
 });
 
 test("convertValueToFieldType converts string to number for number field", () => {
- const result = updateProject.convertValueToFieldType("42", "NUMBER");
+ const result = updateProject.convertValueToFieldType("42", "number");
  expect(result).toBe(42);
 });
 
 test("convertValueToFieldType converts string to float for number field", () => {
- const result = updateProject.convertValueToFieldType("3.14", "NUMBER");
+ const result = updateProject.convertValueToFieldType("3.14", "number");
  expect(result).toBe(3.14);
 });
 
 test("convertValueToFieldType converts zero string to number for number field", () => {
- const result = updateProject.convertValueToFieldType("0", "NUMBER");
+ const result = updateProject.convertValueToFieldType("0", "number");
  expect(result).toBe(0);
 });
 
 test("convertValueToFieldType throws error for invalid number", () => {
  expect(() => {
- updateProject.convertValueToFieldType("not-a-number", "NUMBER");
+ updateProject.convertValueToFieldType("not-a-number", "number");
  }).toThrow("Invalid number value: not-a-number");
 });
 
@@ -617,4 +617,152 @@ describe("with Octokit setup", () => {
  await updateProject.run();
  expect(mock.done()).toBe(true);
  });
+
+ test("fetchContentMetadata returns empty object when issue not in project", async () => {
+ // Mock an issue that exists but has no project items
+ const data = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [], // Empty - issue is not in any project
+ },
+ },
+ },
+ };
+ mockGraphQL(data, "contentMetadata", "projectItems");
+
+ const result = await updateProject.fetchContentMetadata(
+ "I_kwDOABCDEF1234567890",
+ "Status",
+ 9,
+ "webrecorder"
+ );
+ expect(result).toEqual({
+ notInProject: true,
+ nodeId: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ });
+ expect(mock.done()).toBe(true);
+ });
+
+ test("addProjectItem adds item to project", async () => {
+ const data = {
+ data: {
+ addProjectV2ItemById: {
+ item: {
+ id: "PVTI_lADOABCDEF4",
+ },
+ },
+ },
+ };
+ mockGraphQL(data, "addProjectItem", "addProjectV2ItemById");
+
+ const result = await updateProject.addProjectItem(
+ "PVT_kwDOABCDEF4",
+ "I_kwDOABCDEF1234567890"
+ );
+ expect(result.addProjectV2ItemById.item.id).toBe("PVTI_lADOABCDEF4");
+ expect(mock.done()).toBe(true);
+ });
+
+ test("run with auto_add when issue not in project", async () => {
+ // Set up environment with auto_add enabled
+ process.env = {
+ ...OLD_ENV,
+ ...INPUTS,
+ INPUT_AUTO_ADD: "true",
+ INPUT_CONTENT_ID: "I_kwDOABCDEF1234567890",
+ };
+
+ // Mock 1: Issue exists but not in project (first call to fetchContentMetadata)
+ const issueNotInProjectData = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [], // Empty - issue is not in any project
+ },
+ },
+ },
+ };
+ mockGraphQL(
+ issueNotInProjectData,
+ "autoAddContentMetadata1",
+ "projectItems"
+ );
+
+ // Mock 2: Project metadata for getting project ID
+ const field = {
+ id: 1,
+ name: "testField",
+ dataType: "single_select",
+ options: [
+ {
+ id: 1,
+ name: "testValue",
+ },
+ ],
+ };
+ const projectData = {
+ data: {
+ organization: {
+ projectV2: {
+ id: 1,
+ fields: {
+ nodes: [field],
+ },
+ },
+ },
+ },
+ };
+ mockGraphQL(projectData, "autoAddProjectMetadata1", "projectV2");
+
+ // Mock 3: Add item to project
+ const addItemData = {
+ data: {
+ addProjectV2ItemById: {
+ item: {
+ id: "PVTI_lADOABCDEF4",
+ },
+ },
+ },
+ };
+ mockGraphQL(addItemData, "autoAddItem", "addProjectV2ItemById");
+
+ // Mock 4: Issue now in project (second call to fetchContentMetadata)
+ const issueInProjectData = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [
+ {
+ id: "PVTI_lADOABCDEF4",
+ project: { number: 1, owner: { login: "github" } },
+ },
+ ],
+ },
+ },
+ },
+ };
+ mockGraphQL(issueInProjectData, "autoAddContentMetadata2", "projectItems");
+
+ // Mock 5: Project metadata again
+ mockGraphQL(projectData, "autoAddProjectMetadata2", "projectV2");
+
+ // Mock 6: Update field
+ const updateData = { data: { projectV2Item: { id: "PVTI_lADOABCDEF4" } } };
+ mockGraphQL(
+ updateData,
+ "autoAddUpdateField",
+ "updateProjectV2ItemFieldValue"
+ );
+
+ await updateProject.run();
+ expect(mock.done()).toBe(true);
+ });
 });

action.yml

@@ -21,6 +21,10 @@ inputs:
  value:
  description: The value to set the project field to. Only required for operation type read
  required: false
+ auto_add:
+ description: Automatically add the issue or pull request to the project if it's not already in it
+ required: false
+ default: false
  github_token:
  description: A GitHub Token with access to both the source issue and the destination project (`repo` and `write:org` scopes)
  required: true

src/update-project.ts

@@ -86,8 +86,21 @@ export async function fetchContentMetadata(
  );
  const itemTitle = result.node.title;
 
- if (!ensureExists(item, "content", `ID ${contentId}`)) {
- return {};
+ if (!item) {
+ // Check if the node exists but is not in the project
+ if (result.node && result.node.id) {
+ info(
+ `Issue/PR ${contentId} exists but is not in project ${projectNumber} for ${owner}`
+ );
+ return {
+ notInProject: true,
+ nodeId: result.node.id,
+ title: itemTitle,
+ };
+ } else {
+ setFailed(`Item not found with ID ${contentId}`);
+ return {};
+ }
  } else {
  return { ...item, title: itemTitle };
  }
@@ -222,7 +235,7 @@ export function convertValueToFieldType(
  value: string,
  fieldType: string
 ): string | number {
- if (fieldType === "NUMBER") {
+ if (fieldType === "number") {
  const numValue = parseFloat(value);
  if (isNaN(numValue)) {
  throw new Error(`Invalid number value: ${value}`);
@@ -232,6 +245,40 @@ export function convertValueToFieldType(
  return value;
 }
 
+/**
+ * Adds an issue or pull request to a project
+ * @param {string} projectId - The global ID of the project
+ * @param {string} contentId - The global ID of the issue or pull request
+ * @returns {Promise<GraphQlQueryResponseData>} - The added project item
+ */
+export async function addProjectItem(
+ projectId: string,
+ contentId: string
+): Promise<GraphQlQueryResponseData> {
+ const result: GraphQlQueryResponseData = await octokit.graphql(
+ `
+ mutation($project: ID!, $contentId: ID!) {
+ addProjectV2ItemById(
+ input: {
+ projectId: $project
+ contentId: $contentId
+ }
+ ) {
+ item {
+ id
+ }
+ }
+ }
+ `,
+ {
+ project: projectId,
+ contentId,
+ }
+ );
+
+ return result;
+}
+
 /**
  * Updates the field value for the content item
  * @param {GraphQlQueryResponseData} projectMetadata - The project metadata returned from fetchProjectMetadata()
@@ -312,6 +359,7 @@ export function getInputs(): { [key: string]: any } {
  projectNumber: parseInt(getInput("project_number", { required: true })),
  owner: getInput("organization", { required: true }),
  value: getInput("value", { required: operation === "update" }),
+ autoAdd: getInput("auto_add") === "true",
  operation,
  };
 
@@ -337,12 +385,41 @@ export async function run(): Promise<void> {
  const inputs = getInputs();
  if (Object.entries(inputs).length === 0) return;
 
-const contentMetadata = await fetchContentMetadata(
+let contentMetadata = await fetchContentMetadata(
  inputs.contentId,
  inputs.fieldName,
  inputs.projectNumber,
  inputs.owner
  );
+
+ // Check if the item is not in the project but auto_add is enabled
+ if (contentMetadata.notInProject && inputs.autoAdd) {
+ info(
+ `Auto-adding item ${inputs.contentId} to project ${inputs.projectNumber}`
+ );
+
+ // First get the project metadata to get the project ID
+ const projectMetadata = await fetchProjectMetadata(
+ inputs.owner,
+ inputs.projectNumber,
+ inputs.fieldName,
+ inputs.value,
+ inputs.operation
+ );
+ if (Object.entries(projectMetadata).length === 0) return;
+
+ // Add the item to the project
+ await addProjectItem(projectMetadata.projectId, inputs.contentId);
+
+ // Fetch the content metadata again now that it's in the project
+ contentMetadata = await fetchContentMetadata(
+ inputs.contentId,
+ inputs.fieldName,
+ inputs.projectNumber,
+ inputs.owner
+ );
+ }
+
  if (Object.entries(contentMetadata).length === 0) return;
 
  const projectMetadata = await fetchProjectMetadata(

README.md

@@ -53,6 +53,33 @@ jobs:
 
 *Note: The above step can be repeated multiple times in a given job to update multiple fields on the same or different projects.* 
 
+#### Example: Update project status when issue is assigned
+
+When using the `issues` trigger with `assigned` event, you may want to automatically add the issue to a project and set its status:
+
+```yml
+name: Update assigned issues in project
+
+on:
+ issues:
+ types: [assigned]
+
+jobs:
+ update-project-status:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Update status
+ uses: github/update-project-action@v2
+ with:
+ github_token: ${{ secrets.ACTIONS_TOKEN }}
+ organization: webrecorder
+ project_number: 9
+ content_id: ${{ github.event.issue.node_id }}
+ field: Status
+ value: Todo
+ auto_add: true # Automatically add issue to project if not already in it
+```
+
 ### Roadmap
 
 The Action is largely feature complete with regards to its initial goals. Find a bug or have a feature request? [Open an issue](https://github.com/benbalter/update-project-action/issues), or better yet, submit a pull request - contribution welcome!
@@ -66,6 +93,7 @@ The Action is largely feature complete with regards to its initial goals. Find a
 * `organization` - The organization that contains the project, defaults to the current repository owner
 * `project_number` - The project number from the project's URL
 * `value` - The value to set the project field to. Only required for operation type read
+* `auto_add` - Automatically add the issue or pull request to the project if it's not already in it (default: false)
 
 ### Outputs
 

__test__/main.test.ts

@@ -28,23 +28,23 @@ test("valueGraphqlType returns String for text", () => {
 });
 
 test("convertValueToFieldType converts string to number for number field", () => {
- const result = updateProject.convertValueToFieldType("42", "NUMBER");
+ const result = updateProject.convertValueToFieldType("42", "number");
  expect(result).toBe(42);
 });
 
 test("convertValueToFieldType converts string to float for number field", () => {
- const result = updateProject.convertValueToFieldType("3.14", "NUMBER");
+ const result = updateProject.convertValueToFieldType("3.14", "number");
  expect(result).toBe(3.14);
 });
 
 test("convertValueToFieldType converts zero string to number for number field", () => {
- const result = updateProject.convertValueToFieldType("0", "NUMBER");
+ const result = updateProject.convertValueToFieldType("0", "number");
  expect(result).toBe(0);
 });
 
 test("convertValueToFieldType throws error for invalid number", () => {
  expect(() => {
- updateProject.convertValueToFieldType("not-a-number", "NUMBER");
+ updateProject.convertValueToFieldType("not-a-number", "number");
  }).toThrow("Invalid number value: not-a-number");
 });
 
@@ -617,4 +617,152 @@ describe("with Octokit setup", () => {
  await updateProject.run();
  expect(mock.done()).toBe(true);
  });
+
+ test("fetchContentMetadata returns empty object when issue not in project", async () => {
+ // Mock an issue that exists but has no project items
+ const data = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [], // Empty - issue is not in any project
+ },
+ },
+ },
+ };
+ mockGraphQL(data, "contentMetadata", "projectItems");
+
+ const result = await updateProject.fetchContentMetadata(
+ "I_kwDOABCDEF1234567890",
+ "Status",
+ 9,
+ "webrecorder"
+ );
+ expect(result).toEqual({
+ notInProject: true,
+ nodeId: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ });
+ expect(mock.done()).toBe(true);
+ });
+
+ test("addProjectItem adds item to project", async () => {
+ const data = {
+ data: {
+ addProjectV2ItemById: {
+ item: {
+ id: "PVTI_lADOABCDEF4",
+ },
+ },
+ },
+ };
+ mockGraphQL(data, "addProjectItem", "addProjectV2ItemById");
+
+ const result = await updateProject.addProjectItem(
+ "PVT_kwDOABCDEF4",
+ "I_kwDOABCDEF1234567890"
+ );
+ expect(result.addProjectV2ItemById.item.id).toBe("PVTI_lADOABCDEF4");
+ expect(mock.done()).toBe(true);
+ });
+
+ test("run with auto_add when issue not in project", async () => {
+ // Set up environment with auto_add enabled
+ process.env = {
+ ...OLD_ENV,
+ ...INPUTS,
+ INPUT_AUTO_ADD: "true",
+ INPUT_CONTENT_ID: "I_kwDOABCDEF1234567890",
+ };
+
+ // Mock 1: Issue exists but not in project (first call to fetchContentMetadata)
+ const issueNotInProjectData = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [], // Empty - issue is not in any project
+ },
+ },
+ },
+ };
+ mockGraphQL(
+ issueNotInProjectData,
+ "autoAddContentMetadata1",
+ "projectItems"
+ );
+
+ // Mock 2: Project metadata for getting project ID
+ const field = {
+ id: 1,
+ name: "testField",
+ dataType: "single_select",
+ options: [
+ {
+ id: 1,
+ name: "testValue",
+ },
+ ],
+ };
+ const projectData = {
+ data: {
+ organization: {
+ projectV2: {
+ id: 1,
+ fields: {
+ nodes: [field],
+ },
+ },
+ },
+ },
+ };
+ mockGraphQL(projectData, "autoAddProjectMetadata1", "projectV2");
+
+ // Mock 3: Add item to project
+ const addItemData = {
+ data: {
+ addProjectV2ItemById: {
+ item: {
+ id: "PVTI_lADOABCDEF4",
+ },
+ },
+ },
+ };
+ mockGraphQL(addItemData, "autoAddItem", "addProjectV2ItemById");
+
+ // Mock 4: Issue now in project (second call to fetchContentMetadata)
+ const issueInProjectData = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [
+ {
+ id: "PVTI_lADOABCDEF4",
+ project: { number: 1, owner: { login: "github" } },
+ },
+ ],
+ },
+ },
+ },
+ };
+ mockGraphQL(issueInProjectData, "autoAddContentMetadata2", "projectItems");
+
+ // Mock 5: Project metadata again
+ mockGraphQL(projectData, "autoAddProjectMetadata2", "projectV2");
+
+ // Mock 6: Update field
+ const updateData = { data: { projectV2Item: { id: "PVTI_lADOABCDEF4" } } };
+ mockGraphQL(
+ updateData,
+ "autoAddUpdateField",
+ "updateProjectV2ItemFieldValue"
+ );
+
+ await updateProject.run();
+ expect(mock.done()).toBe(true);
+ });
 });

action.yml

@@ -21,6 +21,10 @@ inputs:
  value:
  description: The value to set the project field to. Only required for operation type read
  required: false
+ auto_add:
+ description: Automatically add the issue or pull request to the project if it's not already in it
+ required: false
+ default: false
  github_token:
  description: A GitHub Token with access to both the source issue and the destination project (`repo` and `write:org` scopes)
  required: true

src/update-project.ts

@@ -86,8 +86,21 @@ export async function fetchContentMetadata(
  );
  const itemTitle = result.node.title;
 
- if (!ensureExists(item, "content", `ID ${contentId}`)) {
- return {};
+ if (!item) {
+ // Check if the node exists but is not in the project
+ if (result.node && result.node.id) {
+ info(
+ `Issue/PR ${contentId} exists but is not in project ${projectNumber} for ${owner}`
+ );
+ return {
+ notInProject: true,
+ nodeId: result.node.id,
+ title: itemTitle,
+ };
+ } else {
+ setFailed(`Item not found with ID ${contentId}`);
+ return {};
+ }
  } else {
  return { ...item, title: itemTitle };
  }
@@ -222,7 +235,7 @@ export function convertValueToFieldType(
  value: string,
  fieldType: string
 ): string | number {
- if (fieldType === "NUMBER") {
+ if (fieldType === "number") {
  const numValue = parseFloat(value);
  if (isNaN(numValue)) {
  throw new Error(`Invalid number value: ${value}`);
@@ -232,6 +245,40 @@ export function convertValueToFieldType(
  return value;
 }
 
+/**
+ * Adds an issue or pull request to a project
+ * @param {string} projectId - The global ID of the project
+ * @param {string} contentId - The global ID of the issue or pull request
+ * @returns {Promise<GraphQlQueryResponseData>} - The added project item
+ */
+export async function addProjectItem(
+ projectId: string,
+ contentId: string
+): Promise<GraphQlQueryResponseData> {
+ const result: GraphQlQueryResponseData = await octokit.graphql(
+ `
+ mutation($project: ID!, $contentId: ID!) {
+ addProjectV2ItemById(
+ input: {
+ projectId: $project
+ contentId: $contentId
+ }
+ ) {
+ item {
+ id
+ }
+ }
+ }
+ `,
+ {
+ project: projectId,
+ contentId,
+ }
+ );
+
+ return result;
+}
+
 /**
  * Updates the field value for the content item
  * @param {GraphQlQueryResponseData} projectMetadata - The project metadata returned from fetchProjectMetadata()
@@ -312,6 +359,7 @@ export function getInputs(): { [key: string]: any } {
  projectNumber: parseInt(getInput("project_number", { required: true })),
  owner: getInput("organization", { required: true }),
  value: getInput("value", { required: operation === "update" }),
+ autoAdd: getInput("auto_add") === "true",
  operation,
  };
 
@@ -337,12 +385,41 @@ export async function run(): Promise<void> {
  const inputs = getInputs();
  if (Object.entries(inputs).length === 0) return;
 
-const contentMetadata = await fetchContentMetadata(
+let contentMetadata = await fetchContentMetadata(
  inputs.contentId,
  inputs.fieldName,
  inputs.projectNumber,
  inputs.owner
  );
+
+ // Check if the item is not in the project but auto_add is enabled
+ if (contentMetadata.notInProject && inputs.autoAdd) {
+ info(
+ `Auto-adding item ${inputs.contentId} to project ${inputs.projectNumber}`
+ );
+
+ // First get the project metadata to get the project ID
+ const projectMetadata = await fetchProjectMetadata(
+ inputs.owner,
+ inputs.projectNumber,
+ inputs.fieldName,
+ inputs.value,
+ inputs.operation
+ );
+ if (Object.entries(projectMetadata).length === 0) return;
+
+ // Add the item to the project
+ await addProjectItem(projectMetadata.projectId, inputs.contentId);
+
+ // Fetch the content metadata again now that it's in the project
+ contentMetadata = await fetchContentMetadata(
+ inputs.contentId,
+ inputs.fieldName,
+ inputs.projectNumber,
+ inputs.owner
+ );
+ }
+
  if (Object.entries(contentMetadata).length === 0) return;
 
  const projectMetadata = await fetchProjectMetadata(

README.md

@@ -53,6 +53,33 @@ jobs:
 
 *Note: The above step can be repeated multiple times in a given job to update multiple fields on the same or different projects.* 
 
+#### Example: Update project status when issue is assigned
+
+When using the `issues` trigger with `assigned` event, you may want to automatically add the issue to a project and set its status:
+
+```yml
+name: Update assigned issues in project
+
+on:
+ issues:
+ types: [assigned]
+
+jobs:
+ update-project-status:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Update status
+ uses: github/update-project-action@v2
+ with:
+ github_token: ${{ secrets.ACTIONS_TOKEN }}
+ organization: webrecorder
+ project_number: 9
+ content_id: ${{ github.event.issue.node_id }}
+ field: Status
+ value: Todo
+ auto_add: true # Automatically add issue to project if not already in it
+```
+
 ### Roadmap
 
 The Action is largely feature complete with regards to its initial goals. Find a bug or have a feature request? [Open an issue](https://github.com/benbalter/update-project-action/issues), or better yet, submit a pull request - contribution welcome!
@@ -66,6 +93,7 @@ The Action is largely feature complete with regards to its initial goals. Find a
 * `organization` - The organization that contains the project, defaults to the current repository owner
 * `project_number` - The project number from the project's URL
 * `value` - The value to set the project field to. Only required for operation type read
+* `auto_add` - Automatically add the issue or pull request to the project if it's not already in it (default: false)
 
 ### Outputs
 

__test__/main.test.ts

@@ -28,23 +28,23 @@ test("valueGraphqlType returns String for text", () => {
 });
 
 test("convertValueToFieldType converts string to number for number field", () => {
- const result = updateProject.convertValueToFieldType("42", "NUMBER");
+ const result = updateProject.convertValueToFieldType("42", "number");
  expect(result).toBe(42);
 });
 
 test("convertValueToFieldType converts string to float for number field", () => {
- const result = updateProject.convertValueToFieldType("3.14", "NUMBER");
+ const result = updateProject.convertValueToFieldType("3.14", "number");
  expect(result).toBe(3.14);
 });
 
 test("convertValueToFieldType converts zero string to number for number field", () => {
- const result = updateProject.convertValueToFieldType("0", "NUMBER");
+ const result = updateProject.convertValueToFieldType("0", "number");
  expect(result).toBe(0);
 });
 
 test("convertValueToFieldType throws error for invalid number", () => {
  expect(() => {
- updateProject.convertValueToFieldType("not-a-number", "NUMBER");
+ updateProject.convertValueToFieldType("not-a-number", "number");
  }).toThrow("Invalid number value: not-a-number");
 });
 
@@ -617,4 +617,152 @@ describe("with Octokit setup", () => {
  await updateProject.run();
  expect(mock.done()).toBe(true);
  });
+
+ test("fetchContentMetadata returns empty object when issue not in project", async () => {
+ // Mock an issue that exists but has no project items
+ const data = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [], // Empty - issue is not in any project
+ },
+ },
+ },
+ };
+ mockGraphQL(data, "contentMetadata", "projectItems");
+
+ const result = await updateProject.fetchContentMetadata(
+ "I_kwDOABCDEF1234567890",
+ "Status",
+ 9,
+ "webrecorder"
+ );
+ expect(result).toEqual({
+ notInProject: true,
+ nodeId: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ });
+ expect(mock.done()).toBe(true);
+ });
+
+ test("addProjectItem adds item to project", async () => {
+ const data = {
+ data: {
+ addProjectV2ItemById: {
+ item: {
+ id: "PVTI_lADOABCDEF4",
+ },
+ },
+ },
+ };
+ mockGraphQL(data, "addProjectItem", "addProjectV2ItemById");
+
+ const result = await updateProject.addProjectItem(
+ "PVT_kwDOABCDEF4",
+ "I_kwDOABCDEF1234567890"
+ );
+ expect(result.addProjectV2ItemById.item.id).toBe("PVTI_lADOABCDEF4");
+ expect(mock.done()).toBe(true);
+ });
+
+ test("run with auto_add when issue not in project", async () => {
+ // Set up environment with auto_add enabled
+ process.env = {
+ ...OLD_ENV,
+ ...INPUTS,
+ INPUT_AUTO_ADD: "true",
+ INPUT_CONTENT_ID: "I_kwDOABCDEF1234567890",
+ };
+
+ // Mock 1: Issue exists but not in project (first call to fetchContentMetadata)
+ const issueNotInProjectData = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [], // Empty - issue is not in any project
+ },
+ },
+ },
+ };
+ mockGraphQL(
+ issueNotInProjectData,
+ "autoAddContentMetadata1",
+ "projectItems"
+ );
+
+ // Mock 2: Project metadata for getting project ID
+ const field = {
+ id: 1,
+ name: "testField",
+ dataType: "single_select",
+ options: [
+ {
+ id: 1,
+ name: "testValue",
+ },
+ ],
+ };
+ const projectData = {
+ data: {
+ organization: {
+ projectV2: {
+ id: 1,
+ fields: {
+ nodes: [field],
+ },
+ },
+ },
+ },
+ };
+ mockGraphQL(projectData, "autoAddProjectMetadata1", "projectV2");
+
+ // Mock 3: Add item to project
+ const addItemData = {
+ data: {
+ addProjectV2ItemById: {
+ item: {
+ id: "PVTI_lADOABCDEF4",
+ },
+ },
+ },
+ };
+ mockGraphQL(addItemData, "autoAddItem", "addProjectV2ItemById");
+
+ // Mock 4: Issue now in project (second call to fetchContentMetadata)
+ const issueInProjectData = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [
+ {
+ id: "PVTI_lADOABCDEF4",
+ project: { number: 1, owner: { login: "github" } },
+ },
+ ],
+ },
+ },
+ },
+ };
+ mockGraphQL(issueInProjectData, "autoAddContentMetadata2", "projectItems");
+
+ // Mock 5: Project metadata again
+ mockGraphQL(projectData, "autoAddProjectMetadata2", "projectV2");
+
+ // Mock 6: Update field
+ const updateData = { data: { projectV2Item: { id: "PVTI_lADOABCDEF4" } } };
+ mockGraphQL(
+ updateData,
+ "autoAddUpdateField",
+ "updateProjectV2ItemFieldValue"
+ );
+
+ await updateProject.run();
+ expect(mock.done()).toBe(true);
+ });
 });

action.yml

@@ -21,6 +21,10 @@ inputs:
  value:
  description: The value to set the project field to. Only required for operation type read
  required: false
+ auto_add:
+ description: Automatically add the issue or pull request to the project if it's not already in it
+ required: false
+ default: false
  github_token:
  description: A GitHub Token with access to both the source issue and the destination project (`repo` and `write:org` scopes)
  required: true

src/update-project.ts

@@ -86,8 +86,21 @@ export async function fetchContentMetadata(
  );
  const itemTitle = result.node.title;
 
- if (!ensureExists(item, "content", `ID ${contentId}`)) {
- return {};
+ if (!item) {
+ // Check if the node exists but is not in the project
+ if (result.node && result.node.id) {
+ info(
+ `Issue/PR ${contentId} exists but is not in project ${projectNumber} for ${owner}`
+ );
+ return {
+ notInProject: true,
+ nodeId: result.node.id,
+ title: itemTitle,
+ };
+ } else {
+ setFailed(`Item not found with ID ${contentId}`);
+ return {};
+ }
  } else {
  return { ...item, title: itemTitle };
  }
@@ -222,7 +235,7 @@ export function convertValueToFieldType(
  value: string,
  fieldType: string
 ): string | number {
- if (fieldType === "NUMBER") {
+ if (fieldType === "number") {
  const numValue = parseFloat(value);
  if (isNaN(numValue)) {
  throw new Error(`Invalid number value: ${value}`);
@@ -232,6 +245,40 @@ export function convertValueToFieldType(
  return value;
 }
 
+/**
+ * Adds an issue or pull request to a project
+ * @param {string} projectId - The global ID of the project
+ * @param {string} contentId - The global ID of the issue or pull request
+ * @returns {Promise<GraphQlQueryResponseData>} - The added project item
+ */
+export async function addProjectItem(
+ projectId: string,
+ contentId: string
+): Promise<GraphQlQueryResponseData> {
+ const result: GraphQlQueryResponseData = await octokit.graphql(
+ `
+ mutation($project: ID!, $contentId: ID!) {
+ addProjectV2ItemById(
+ input: {
+ projectId: $project
+ contentId: $contentId
+ }
+ ) {
+ item {
+ id
+ }
+ }
+ }
+ `,
+ {
+ project: projectId,
+ contentId,
+ }
+ );
+
+ return result;
+}
+
 /**
  * Updates the field value for the content item
  * @param {GraphQlQueryResponseData} projectMetadata - The project metadata returned from fetchProjectMetadata()
@@ -312,6 +359,7 @@ export function getInputs(): { [key: string]: any } {
  projectNumber: parseInt(getInput("project_number", { required: true })),
  owner: getInput("organization", { required: true }),
  value: getInput("value", { required: operation === "update" }),
+ autoAdd: getInput("auto_add") === "true",
  operation,
  };
 
@@ -337,12 +385,41 @@ export async function run(): Promise<void> {
  const inputs = getInputs();
  if (Object.entries(inputs).length === 0) return;
 
-const contentMetadata = await fetchContentMetadata(
+let contentMetadata = await fetchContentMetadata(
  inputs.contentId,
  inputs.fieldName,
  inputs.projectNumber,
  inputs.owner
  );
+
+ // Check if the item is not in the project but auto_add is enabled
+ if (contentMetadata.notInProject && inputs.autoAdd) {
+ info(
+ `Auto-adding item ${inputs.contentId} to project ${inputs.projectNumber}`
+ );
+
+ // First get the project metadata to get the project ID
+ const projectMetadata = await fetchProjectMetadata(
+ inputs.owner,
+ inputs.projectNumber,
+ inputs.fieldName,
+ inputs.value,
+ inputs.operation
+ );
+ if (Object.entries(projectMetadata).length === 0) return;
+
+ // Add the item to the project
+ await addProjectItem(projectMetadata.projectId, inputs.contentId);
+
+ // Fetch the content metadata again now that it's in the project
+ contentMetadata = await fetchContentMetadata(
+ inputs.contentId,
+ inputs.fieldName,
+ inputs.projectNumber,
+ inputs.owner
+ );
+ }
+
  if (Object.entries(contentMetadata).length === 0) return;
 
  const projectMetadata = await fetchProjectMetadata(

README.md

@@ -53,6 +53,33 @@ jobs:
 
 *Note: The above step can be repeated multiple times in a given job to update multiple fields on the same or different projects.* 
 
+#### Example: Update project status when issue is assigned
+
+When using the `issues` trigger with `assigned` event, you may want to automatically add the issue to a project and set its status:
+
+```yml
+name: Update assigned issues in project
+
+on:
+ issues:
+ types: [assigned]
+
+jobs:
+ update-project-status:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Update status
+ uses: github/update-project-action@v2
+ with:
+ github_token: ${{ secrets.ACTIONS_TOKEN }}
+ organization: webrecorder
+ project_number: 9
+ content_id: ${{ github.event.issue.node_id }}
+ field: Status
+ value: Todo
+ auto_add: true # Automatically add issue to project if not already in it
+```
+
 ### Roadmap
 
 The Action is largely feature complete with regards to its initial goals. Find a bug or have a feature request? [Open an issue](https://github.com/benbalter/update-project-action/issues), or better yet, submit a pull request - contribution welcome!
@@ -66,6 +93,7 @@ The Action is largely feature complete with regards to its initial goals. Find a
 * `organization` - The organization that contains the project, defaults to the current repository owner
 * `project_number` - The project number from the project's URL
 * `value` - The value to set the project field to. Only required for operation type read
+* `auto_add` - Automatically add the issue or pull request to the project if it's not already in it (default: false)
 
 ### Outputs
 

__test__/main.test.ts

@@ -28,23 +28,23 @@ test("valueGraphqlType returns String for text", () => {
 });
 
 test("convertValueToFieldType converts string to number for number field", () => {
- const result = updateProject.convertValueToFieldType("42", "NUMBER");
+ const result = updateProject.convertValueToFieldType("42", "number");
  expect(result).toBe(42);
 });
 
 test("convertValueToFieldType converts string to float for number field", () => {
- const result = updateProject.convertValueToFieldType("3.14", "NUMBER");
+ const result = updateProject.convertValueToFieldType("3.14", "number");
  expect(result).toBe(3.14);
 });
 
 test("convertValueToFieldType converts zero string to number for number field", () => {
- const result = updateProject.convertValueToFieldType("0", "NUMBER");
+ const result = updateProject.convertValueToFieldType("0", "number");
  expect(result).toBe(0);
 });
 
 test("convertValueToFieldType throws error for invalid number", () => {
  expect(() => {
- updateProject.convertValueToFieldType("not-a-number", "NUMBER");
+ updateProject.convertValueToFieldType("not-a-number", "number");
  }).toThrow("Invalid number value: not-a-number");
 });
 
@@ -617,4 +617,152 @@ describe("with Octokit setup", () => {
  await updateProject.run();
  expect(mock.done()).toBe(true);
  });
+
+ test("fetchContentMetadata returns empty object when issue not in project", async () => {
+ // Mock an issue that exists but has no project items
+ const data = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [], // Empty - issue is not in any project
+ },
+ },
+ },
+ };
+ mockGraphQL(data, "contentMetadata", "projectItems");
+
+ const result = await updateProject.fetchContentMetadata(
+ "I_kwDOABCDEF1234567890",
+ "Status",
+ 9,
+ "webrecorder"
+ );
+ expect(result).toEqual({
+ notInProject: true,
+ nodeId: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ });
+ expect(mock.done()).toBe(true);
+ });
+
+ test("addProjectItem adds item to project", async () => {
+ const data = {
+ data: {
+ addProjectV2ItemById: {
+ item: {
+ id: "PVTI_lADOABCDEF4",
+ },
+ },
+ },
+ };
+ mockGraphQL(data, "addProjectItem", "addProjectV2ItemById");
+
+ const result = await updateProject.addProjectItem(
+ "PVT_kwDOABCDEF4",
+ "I_kwDOABCDEF1234567890"
+ );
+ expect(result.addProjectV2ItemById.item.id).toBe("PVTI_lADOABCDEF4");
+ expect(mock.done()).toBe(true);
+ });
+
+ test("run with auto_add when issue not in project", async () => {
+ // Set up environment with auto_add enabled
+ process.env = {
+ ...OLD_ENV,
+ ...INPUTS,
+ INPUT_AUTO_ADD: "true",
+ INPUT_CONTENT_ID: "I_kwDOABCDEF1234567890",
+ };
+
+ // Mock 1: Issue exists but not in project (first call to fetchContentMetadata)
+ const issueNotInProjectData = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [], // Empty - issue is not in any project
+ },
+ },
+ },
+ };
+ mockGraphQL(
+ issueNotInProjectData,
+ "autoAddContentMetadata1",
+ "projectItems"
+ );
+
+ // Mock 2: Project metadata for getting project ID
+ const field = {
+ id: 1,
+ name: "testField",
+ dataType: "single_select",
+ options: [
+ {
+ id: 1,
+ name: "testValue",
+ },
+ ],
+ };
+ const projectData = {
+ data: {
+ organization: {
+ projectV2: {
+ id: 1,
+ fields: {
+ nodes: [field],
+ },
+ },
+ },
+ },
+ };
+ mockGraphQL(projectData, "autoAddProjectMetadata1", "projectV2");
+
+ // Mock 3: Add item to project
+ const addItemData = {
+ data: {
+ addProjectV2ItemById: {
+ item: {
+ id: "PVTI_lADOABCDEF4",
+ },
+ },
+ },
+ };
+ mockGraphQL(addItemData, "autoAddItem", "addProjectV2ItemById");
+
+ // Mock 4: Issue now in project (second call to fetchContentMetadata)
+ const issueInProjectData = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [
+ {
+ id: "PVTI_lADOABCDEF4",
+ project: { number: 1, owner: { login: "github" } },
+ },
+ ],
+ },
+ },
+ },
+ };
+ mockGraphQL(issueInProjectData, "autoAddContentMetadata2", "projectItems");
+
+ // Mock 5: Project metadata again
+ mockGraphQL(projectData, "autoAddProjectMetadata2", "projectV2");
+
+ // Mock 6: Update field
+ const updateData = { data: { projectV2Item: { id: "PVTI_lADOABCDEF4" } } };
+ mockGraphQL(
+ updateData,
+ "autoAddUpdateField",
+ "updateProjectV2ItemFieldValue"
+ );
+
+ await updateProject.run();
+ expect(mock.done()).toBe(true);
+ });
 });

action.yml

@@ -21,6 +21,10 @@ inputs:
  value:
  description: The value to set the project field to. Only required for operation type read
  required: false
+ auto_add:
+ description: Automatically add the issue or pull request to the project if it's not already in it
+ required: false
+ default: false
  github_token:
  description: A GitHub Token with access to both the source issue and the destination project (`repo` and `write:org` scopes)
  required: true

src/update-project.ts

@@ -86,8 +86,21 @@ export async function fetchContentMetadata(
  );
  const itemTitle = result.node.title;
 
- if (!ensureExists(item, "content", `ID ${contentId}`)) {
- return {};
+ if (!item) {
+ // Check if the node exists but is not in the project
+ if (result.node && result.node.id) {
+ info(
+ `Issue/PR ${contentId} exists but is not in project ${projectNumber} for ${owner}`
+ );
+ return {
+ notInProject: true,
+ nodeId: result.node.id,
+ title: itemTitle,
+ };
+ } else {
+ setFailed(`Item not found with ID ${contentId}`);
+ return {};
+ }
  } else {
  return { ...item, title: itemTitle };
  }
@@ -222,7 +235,7 @@ export function convertValueToFieldType(
  value: string,
  fieldType: string
 ): string | number {
- if (fieldType === "NUMBER") {
+ if (fieldType === "number") {
  const numValue = parseFloat(value);
  if (isNaN(numValue)) {
  throw new Error(`Invalid number value: ${value}`);
@@ -232,6 +245,40 @@ export function convertValueToFieldType(
  return value;
 }
 
+/**
+ * Adds an issue or pull request to a project
+ * @param {string} projectId - The global ID of the project
+ * @param {string} contentId - The global ID of the issue or pull request
+ * @returns {Promise<GraphQlQueryResponseData>} - The added project item
+ */
+export async function addProjectItem(
+ projectId: string,
+ contentId: string
+): Promise<GraphQlQueryResponseData> {
+ const result: GraphQlQueryResponseData = await octokit.graphql(
+ `
+ mutation($project: ID!, $contentId: ID!) {
+ addProjectV2ItemById(
+ input: {
+ projectId: $project
+ contentId: $contentId
+ }
+ ) {
+ item {
+ id
+ }
+ }
+ }
+ `,
+ {
+ project: projectId,
+ contentId,
+ }
+ );
+
+ return result;
+}
+
 /**
  * Updates the field value for the content item
  * @param {GraphQlQueryResponseData} projectMetadata - The project metadata returned from fetchProjectMetadata()
@@ -312,6 +359,7 @@ export function getInputs(): { [key: string]: any } {
  projectNumber: parseInt(getInput("project_number", { required: true })),
  owner: getInput("organization", { required: true }),
  value: getInput("value", { required: operation === "update" }),
+ autoAdd: getInput("auto_add") === "true",
  operation,
  };
 
@@ -337,12 +385,41 @@ export async function run(): Promise<void> {
  const inputs = getInputs();
  if (Object.entries(inputs).length === 0) return;
 
-const contentMetadata = await fetchContentMetadata(
+let contentMetadata = await fetchContentMetadata(
  inputs.contentId,
  inputs.fieldName,
  inputs.projectNumber,
  inputs.owner
  );
+
+ // Check if the item is not in the project but auto_add is enabled
+ if (contentMetadata.notInProject && inputs.autoAdd) {
+ info(
+ `Auto-adding item ${inputs.contentId} to project ${inputs.projectNumber}`
+ );
+
+ // First get the project metadata to get the project ID
+ const projectMetadata = await fetchProjectMetadata(
+ inputs.owner,
+ inputs.projectNumber,
+ inputs.fieldName,
+ inputs.value,
+ inputs.operation
+ );
+ if (Object.entries(projectMetadata).length === 0) return;
+
+ // Add the item to the project
+ await addProjectItem(projectMetadata.projectId, inputs.contentId);
+
+ // Fetch the content metadata again now that it's in the project
+ contentMetadata = await fetchContentMetadata(
+ inputs.contentId,
+ inputs.fieldName,
+ inputs.projectNumber,
+ inputs.owner
+ );
+ }
+
  if (Object.entries(contentMetadata).length === 0) return;
 
  const projectMetadata = await fetchProjectMetadata(

README.md

@@ -53,6 +53,33 @@ jobs:
 
 *Note: The above step can be repeated multiple times in a given job to update multiple fields on the same or different projects.* 
 
+#### Example: Update project status when issue is assigned
+
+When using the `issues` trigger with `assigned` event, you may want to automatically add the issue to a project and set its status:
+
+```yml
+name: Update assigned issues in project
+
+on:
+ issues:
+ types: [assigned]
+
+jobs:
+ update-project-status:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Update status
+ uses: github/update-project-action@v2
+ with:
+ github_token: ${{ secrets.ACTIONS_TOKEN }}
+ organization: webrecorder
+ project_number: 9
+ content_id: ${{ github.event.issue.node_id }}
+ field: Status
+ value: Todo
+ auto_add: true # Automatically add issue to project if not already in it
+```
+
 ### Roadmap
 
 The Action is largely feature complete with regards to its initial goals. Find a bug or have a feature request? [Open an issue](https://github.com/benbalter/update-project-action/issues), or better yet, submit a pull request - contribution welcome!
@@ -66,6 +93,7 @@ The Action is largely feature complete with regards to its initial goals. Find a
 * `organization` - The organization that contains the project, defaults to the current repository owner
 * `project_number` - The project number from the project's URL
 * `value` - The value to set the project field to. Only required for operation type read
+* `auto_add` - Automatically add the issue or pull request to the project if it's not already in it (default: false)
 
 ### Outputs
 

__test__/main.test.ts

@@ -28,23 +28,23 @@ test("valueGraphqlType returns String for text", () => {
 });
 
 test("convertValueToFieldType converts string to number for number field", () => {
- const result = updateProject.convertValueToFieldType("42", "NUMBER");
+ const result = updateProject.convertValueToFieldType("42", "number");
  expect(result).toBe(42);
 });
 
 test("convertValueToFieldType converts string to float for number field", () => {
- const result = updateProject.convertValueToFieldType("3.14", "NUMBER");
+ const result = updateProject.convertValueToFieldType("3.14", "number");
  expect(result).toBe(3.14);
 });
 
 test("convertValueToFieldType converts zero string to number for number field", () => {
- const result = updateProject.convertValueToFieldType("0", "NUMBER");
+ const result = updateProject.convertValueToFieldType("0", "number");
  expect(result).toBe(0);
 });
 
 test("convertValueToFieldType throws error for invalid number", () => {
  expect(() => {
- updateProject.convertValueToFieldType("not-a-number", "NUMBER");
+ updateProject.convertValueToFieldType("not-a-number", "number");
  }).toThrow("Invalid number value: not-a-number");
 });
 
@@ -617,4 +617,152 @@ describe("with Octokit setup", () => {
  await updateProject.run();
  expect(mock.done()).toBe(true);
  });
+
+ test("fetchContentMetadata returns empty object when issue not in project", async () => {
+ // Mock an issue that exists but has no project items
+ const data = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [], // Empty - issue is not in any project
+ },
+ },
+ },
+ };
+ mockGraphQL(data, "contentMetadata", "projectItems");
+
+ const result = await updateProject.fetchContentMetadata(
+ "I_kwDOABCDEF1234567890",
+ "Status",
+ 9,
+ "webrecorder"
+ );
+ expect(result).toEqual({
+ notInProject: true,
+ nodeId: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ });
+ expect(mock.done()).toBe(true);
+ });
+
+ test("addProjectItem adds item to project", async () => {
+ const data = {
+ data: {
+ addProjectV2ItemById: {
+ item: {
+ id: "PVTI_lADOABCDEF4",
+ },
+ },
+ },
+ };
+ mockGraphQL(data, "addProjectItem", "addProjectV2ItemById");
+
+ const result = await updateProject.addProjectItem(
+ "PVT_kwDOABCDEF4",
+ "I_kwDOABCDEF1234567890"
+ );
+ expect(result.addProjectV2ItemById.item.id).toBe("PVTI_lADOABCDEF4");
+ expect(mock.done()).toBe(true);
+ });
+
+ test("run with auto_add when issue not in project", async () => {
+ // Set up environment with auto_add enabled
+ process.env = {
+ ...OLD_ENV,
+ ...INPUTS,
+ INPUT_AUTO_ADD: "true",
+ INPUT_CONTENT_ID: "I_kwDOABCDEF1234567890",
+ };
+
+ // Mock 1: Issue exists but not in project (first call to fetchContentMetadata)
+ const issueNotInProjectData = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [], // Empty - issue is not in any project
+ },
+ },
+ },
+ };
+ mockGraphQL(
+ issueNotInProjectData,
+ "autoAddContentMetadata1",
+ "projectItems"
+ );
+
+ // Mock 2: Project metadata for getting project ID
+ const field = {
+ id: 1,
+ name: "testField",
+ dataType: "single_select",
+ options: [
+ {
+ id: 1,
+ name: "testValue",
+ },
+ ],
+ };
+ const projectData = {
+ data: {
+ organization: {
+ projectV2: {
+ id: 1,
+ fields: {
+ nodes: [field],
+ },
+ },
+ },
+ },
+ };
+ mockGraphQL(projectData, "autoAddProjectMetadata1", "projectV2");
+
+ // Mock 3: Add item to project
+ const addItemData = {
+ data: {
+ addProjectV2ItemById: {
+ item: {
+ id: "PVTI_lADOABCDEF4",
+ },
+ },
+ },
+ };
+ mockGraphQL(addItemData, "autoAddItem", "addProjectV2ItemById");
+
+ // Mock 4: Issue now in project (second call to fetchContentMetadata)
+ const issueInProjectData = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [
+ {
+ id: "PVTI_lADOABCDEF4",
+ project: { number: 1, owner: { login: "github" } },
+ },
+ ],
+ },
+ },
+ },
+ };
+ mockGraphQL(issueInProjectData, "autoAddContentMetadata2", "projectItems");
+
+ // Mock 5: Project metadata again
+ mockGraphQL(projectData, "autoAddProjectMetadata2", "projectV2");
+
+ // Mock 6: Update field
+ const updateData = { data: { projectV2Item: { id: "PVTI_lADOABCDEF4" } } };
+ mockGraphQL(
+ updateData,
+ "autoAddUpdateField",
+ "updateProjectV2ItemFieldValue"
+ );
+
+ await updateProject.run();
+ expect(mock.done()).toBe(true);
+ });
 });

action.yml

@@ -21,6 +21,10 @@ inputs:
  value:
  description: The value to set the project field to. Only required for operation type read
  required: false
+ auto_add:
+ description: Automatically add the issue or pull request to the project if it's not already in it
+ required: false
+ default: false
  github_token:
  description: A GitHub Token with access to both the source issue and the destination project (`repo` and `write:org` scopes)
  required: true

src/update-project.ts

@@ -86,8 +86,21 @@ export async function fetchContentMetadata(
  );
  const itemTitle = result.node.title;
 
- if (!ensureExists(item, "content", `ID ${contentId}`)) {
- return {};
+ if (!item) {
+ // Check if the node exists but is not in the project
+ if (result.node && result.node.id) {
+ info(
+ `Issue/PR ${contentId} exists but is not in project ${projectNumber} for ${owner}`
+ );
+ return {
+ notInProject: true,
+ nodeId: result.node.id,
+ title: itemTitle,
+ };
+ } else {
+ setFailed(`Item not found with ID ${contentId}`);
+ return {};
+ }
  } else {
  return { ...item, title: itemTitle };
  }
@@ -222,7 +235,7 @@ export function convertValueToFieldType(
  value: string,
  fieldType: string
 ): string | number {
- if (fieldType === "NUMBER") {
+ if (fieldType === "number") {
  const numValue = parseFloat(value);
  if (isNaN(numValue)) {
  throw new Error(`Invalid number value: ${value}`);
@@ -232,6 +245,40 @@ export function convertValueToFieldType(
  return value;
 }
 
+/**
+ * Adds an issue or pull request to a project
+ * @param {string} projectId - The global ID of the project
+ * @param {string} contentId - The global ID of the issue or pull request
+ * @returns {Promise<GraphQlQueryResponseData>} - The added project item
+ */
+export async function addProjectItem(
+ projectId: string,
+ contentId: string
+): Promise<GraphQlQueryResponseData> {
+ const result: GraphQlQueryResponseData = await octokit.graphql(
+ `
+ mutation($project: ID!, $contentId: ID!) {
+ addProjectV2ItemById(
+ input: {
+ projectId: $project
+ contentId: $contentId
+ }
+ ) {
+ item {
+ id
+ }
+ }
+ }
+ `,
+ {
+ project: projectId,
+ contentId,
+ }
+ );
+
+ return result;
+}
+
 /**
  * Updates the field value for the content item
  * @param {GraphQlQueryResponseData} projectMetadata - The project metadata returned from fetchProjectMetadata()
@@ -312,6 +359,7 @@ export function getInputs(): { [key: string]: any } {
  projectNumber: parseInt(getInput("project_number", { required: true })),
  owner: getInput("organization", { required: true }),
  value: getInput("value", { required: operation === "update" }),
+ autoAdd: getInput("auto_add") === "true",
  operation,
  };
 
@@ -337,12 +385,41 @@ export async function run(): Promise<void> {
  const inputs = getInputs();
  if (Object.entries(inputs).length === 0) return;
 
-const contentMetadata = await fetchContentMetadata(
+let contentMetadata = await fetchContentMetadata(
  inputs.contentId,
  inputs.fieldName,
  inputs.projectNumber,
  inputs.owner
  );
+
+ // Check if the item is not in the project but auto_add is enabled
+ if (contentMetadata.notInProject && inputs.autoAdd) {
+ info(
+ `Auto-adding item ${inputs.contentId} to project ${inputs.projectNumber}`
+ );
+
+ // First get the project metadata to get the project ID
+ const projectMetadata = await fetchProjectMetadata(
+ inputs.owner,
+ inputs.projectNumber,
+ inputs.fieldName,
+ inputs.value,
+ inputs.operation
+ );
+ if (Object.entries(projectMetadata).length === 0) return;
+
+ // Add the item to the project
+ await addProjectItem(projectMetadata.projectId, inputs.contentId);
+
+ // Fetch the content metadata again now that it's in the project
+ contentMetadata = await fetchContentMetadata(
+ inputs.contentId,
+ inputs.fieldName,
+ inputs.projectNumber,
+ inputs.owner
+ );
+ }
+
  if (Object.entries(contentMetadata).length === 0) return;
 
  const projectMetadata = await fetchProjectMetadata(

README.md

@@ -53,6 +53,33 @@ jobs:
 
 *Note: The above step can be repeated multiple times in a given job to update multiple fields on the same or different projects.* 
 
+#### Example: Update project status when issue is assigned
+
+When using the `issues` trigger with `assigned` event, you may want to automatically add the issue to a project and set its status:
+
+```yml
+name: Update assigned issues in project
+
+on:
+ issues:
+ types: [assigned]
+
+jobs:
+ update-project-status:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Update status
+ uses: github/update-project-action@v2
+ with:
+ github_token: ${{ secrets.ACTIONS_TOKEN }}
+ organization: webrecorder
+ project_number: 9
+ content_id: ${{ github.event.issue.node_id }}
+ field: Status
+ value: Todo
+ auto_add: true # Automatically add issue to project if not already in it
+```
+
 ### Roadmap
 
 The Action is largely feature complete with regards to its initial goals. Find a bug or have a feature request? [Open an issue](https://github.com/benbalter/update-project-action/issues), or better yet, submit a pull request - contribution welcome!
@@ -66,6 +93,7 @@ The Action is largely feature complete with regards to its initial goals. Find a
 * `organization` - The organization that contains the project, defaults to the current repository owner
 * `project_number` - The project number from the project's URL
 * `value` - The value to set the project field to. Only required for operation type read
+* `auto_add` - Automatically add the issue or pull request to the project if it's not already in it (default: false)
 
 ### Outputs
 

__test__/main.test.ts

@@ -28,23 +28,23 @@ test("valueGraphqlType returns String for text", () => {
 });
 
 test("convertValueToFieldType converts string to number for number field", () => {
- const result = updateProject.convertValueToFieldType("42", "NUMBER");
+ const result = updateProject.convertValueToFieldType("42", "number");
  expect(result).toBe(42);
 });
 
 test("convertValueToFieldType converts string to float for number field", () => {
- const result = updateProject.convertValueToFieldType("3.14", "NUMBER");
+ const result = updateProject.convertValueToFieldType("3.14", "number");
  expect(result).toBe(3.14);
 });
 
 test("convertValueToFieldType converts zero string to number for number field", () => {
- const result = updateProject.convertValueToFieldType("0", "NUMBER");
+ const result = updateProject.convertValueToFieldType("0", "number");
  expect(result).toBe(0);
 });
 
 test("convertValueToFieldType throws error for invalid number", () => {
  expect(() => {
- updateProject.convertValueToFieldType("not-a-number", "NUMBER");
+ updateProject.convertValueToFieldType("not-a-number", "number");
  }).toThrow("Invalid number value: not-a-number");
 });
 
@@ -617,4 +617,152 @@ describe("with Octokit setup", () => {
  await updateProject.run();
  expect(mock.done()).toBe(true);
  });
+
+ test("fetchContentMetadata returns empty object when issue not in project", async () => {
+ // Mock an issue that exists but has no project items
+ const data = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [], // Empty - issue is not in any project
+ },
+ },
+ },
+ };
+ mockGraphQL(data, "contentMetadata", "projectItems");
+
+ const result = await updateProject.fetchContentMetadata(
+ "I_kwDOABCDEF1234567890",
+ "Status",
+ 9,
+ "webrecorder"
+ );
+ expect(result).toEqual({
+ notInProject: true,
+ nodeId: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ });
+ expect(mock.done()).toBe(true);
+ });
+
+ test("addProjectItem adds item to project", async () => {
+ const data = {
+ data: {
+ addProjectV2ItemById: {
+ item: {
+ id: "PVTI_lADOABCDEF4",
+ },
+ },
+ },
+ };
+ mockGraphQL(data, "addProjectItem", "addProjectV2ItemById");
+
+ const result = await updateProject.addProjectItem(
+ "PVT_kwDOABCDEF4",
+ "I_kwDOABCDEF1234567890"
+ );
+ expect(result.addProjectV2ItemById.item.id).toBe("PVTI_lADOABCDEF4");
+ expect(mock.done()).toBe(true);
+ });
+
+ test("run with auto_add when issue not in project", async () => {
+ // Set up environment with auto_add enabled
+ process.env = {
+ ...OLD_ENV,
+ ...INPUTS,
+ INPUT_AUTO_ADD: "true",
+ INPUT_CONTENT_ID: "I_kwDOABCDEF1234567890",
+ };
+
+ // Mock 1: Issue exists but not in project (first call to fetchContentMetadata)
+ const issueNotInProjectData = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [], // Empty - issue is not in any project
+ },
+ },
+ },
+ };
+ mockGraphQL(
+ issueNotInProjectData,
+ "autoAddContentMetadata1",
+ "projectItems"
+ );
+
+ // Mock 2: Project metadata for getting project ID
+ const field = {
+ id: 1,
+ name: "testField",
+ dataType: "single_select",
+ options: [
+ {
+ id: 1,
+ name: "testValue",
+ },
+ ],
+ };
+ const projectData = {
+ data: {
+ organization: {
+ projectV2: {
+ id: 1,
+ fields: {
+ nodes: [field],
+ },
+ },
+ },
+ },
+ };
+ mockGraphQL(projectData, "autoAddProjectMetadata1", "projectV2");
+
+ // Mock 3: Add item to project
+ const addItemData = {
+ data: {
+ addProjectV2ItemById: {
+ item: {
+ id: "PVTI_lADOABCDEF4",
+ },
+ },
+ },
+ };
+ mockGraphQL(addItemData, "autoAddItem", "addProjectV2ItemById");
+
+ // Mock 4: Issue now in project (second call to fetchContentMetadata)
+ const issueInProjectData = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [
+ {
+ id: "PVTI_lADOABCDEF4",
+ project: { number: 1, owner: { login: "github" } },
+ },
+ ],
+ },
+ },
+ },
+ };
+ mockGraphQL(issueInProjectData, "autoAddContentMetadata2", "projectItems");
+
+ // Mock 5: Project metadata again
+ mockGraphQL(projectData, "autoAddProjectMetadata2", "projectV2");
+
+ // Mock 6: Update field
+ const updateData = { data: { projectV2Item: { id: "PVTI_lADOABCDEF4" } } };
+ mockGraphQL(
+ updateData,
+ "autoAddUpdateField",
+ "updateProjectV2ItemFieldValue"
+ );
+
+ await updateProject.run();
+ expect(mock.done()).toBe(true);
+ });
 });

action.yml

@@ -21,6 +21,10 @@ inputs:
  value:
  description: The value to set the project field to. Only required for operation type read
  required: false
+ auto_add:
+ description: Automatically add the issue or pull request to the project if it's not already in it
+ required: false
+ default: false
  github_token:
  description: A GitHub Token with access to both the source issue and the destination project (`repo` and `write:org` scopes)
  required: true

src/update-project.ts

@@ -86,8 +86,21 @@ export async function fetchContentMetadata(
  );
  const itemTitle = result.node.title;
 
- if (!ensureExists(item, "content", `ID ${contentId}`)) {
- return {};
+ if (!item) {
+ // Check if the node exists but is not in the project
+ if (result.node && result.node.id) {
+ info(
+ `Issue/PR ${contentId} exists but is not in project ${projectNumber} for ${owner}`
+ );
+ return {
+ notInProject: true,
+ nodeId: result.node.id,
+ title: itemTitle,
+ };
+ } else {
+ setFailed(`Item not found with ID ${contentId}`);
+ return {};
+ }
  } else {
  return { ...item, title: itemTitle };
  }
@@ -222,7 +235,7 @@ export function convertValueToFieldType(
  value: string,
  fieldType: string
 ): string | number {
- if (fieldType === "NUMBER") {
+ if (fieldType === "number") {
  const numValue = parseFloat(value);
  if (isNaN(numValue)) {
  throw new Error(`Invalid number value: ${value}`);
@@ -232,6 +245,40 @@ export function convertValueToFieldType(
  return value;
 }
 
+/**
+ * Adds an issue or pull request to a project
+ * @param {string} projectId - The global ID of the project
+ * @param {string} contentId - The global ID of the issue or pull request
+ * @returns {Promise<GraphQlQueryResponseData>} - The added project item
+ */
+export async function addProjectItem(
+ projectId: string,
+ contentId: string
+): Promise<GraphQlQueryResponseData> {
+ const result: GraphQlQueryResponseData = await octokit.graphql(
+ `
+ mutation($project: ID!, $contentId: ID!) {
+ addProjectV2ItemById(
+ input: {
+ projectId: $project
+ contentId: $contentId
+ }
+ ) {
+ item {
+ id
+ }
+ }
+ }
+ `,
+ {
+ project: projectId,
+ contentId,
+ }
+ );
+
+ return result;
+}
+
 /**
  * Updates the field value for the content item
  * @param {GraphQlQueryResponseData} projectMetadata - The project metadata returned from fetchProjectMetadata()
@@ -312,6 +359,7 @@ export function getInputs(): { [key: string]: any } {
  projectNumber: parseInt(getInput("project_number", { required: true })),
  owner: getInput("organization", { required: true }),
  value: getInput("value", { required: operation === "update" }),
+ autoAdd: getInput("auto_add") === "true",
  operation,
  };
 
@@ -337,12 +385,41 @@ export async function run(): Promise<void> {
  const inputs = getInputs();
  if (Object.entries(inputs).length === 0) return;
 
-const contentMetadata = await fetchContentMetadata(
+let contentMetadata = await fetchContentMetadata(
  inputs.contentId,
  inputs.fieldName,
  inputs.projectNumber,
  inputs.owner
  );
+
+ // Check if the item is not in the project but auto_add is enabled
+ if (contentMetadata.notInProject && inputs.autoAdd) {
+ info(
+ `Auto-adding item ${inputs.contentId} to project ${inputs.projectNumber}`
+ );
+
+ // First get the project metadata to get the project ID
+ const projectMetadata = await fetchProjectMetadata(
+ inputs.owner,
+ inputs.projectNumber,
+ inputs.fieldName,
+ inputs.value,
+ inputs.operation
+ );
+ if (Object.entries(projectMetadata).length === 0) return;
+
+ // Add the item to the project
+ await addProjectItem(projectMetadata.projectId, inputs.contentId);
+
+ // Fetch the content metadata again now that it's in the project
+ contentMetadata = await fetchContentMetadata(
+ inputs.contentId,
+ inputs.fieldName,
+ inputs.projectNumber,
+ inputs.owner
+ );
+ }
+
  if (Object.entries(contentMetadata).length === 0) return;
 
  const projectMetadata = await fetchProjectMetadata(

README.md

@@ -53,6 +53,33 @@ jobs:
 
 *Note: The above step can be repeated multiple times in a given job to update multiple fields on the same or different projects.* 
 
+#### Example: Update project status when issue is assigned
+
+When using the `issues` trigger with `assigned` event, you may want to automatically add the issue to a project and set its status:
+
+```yml
+name: Update assigned issues in project
+
+on:
+ issues:
+ types: [assigned]
+
+jobs:
+ update-project-status:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Update status
+ uses: github/update-project-action@v2
+ with:
+ github_token: ${{ secrets.ACTIONS_TOKEN }}
+ organization: webrecorder
+ project_number: 9
+ content_id: ${{ github.event.issue.node_id }}
+ field: Status
+ value: Todo
+ auto_add: true # Automatically add issue to project if not already in it
+```
+
 ### Roadmap
 
 The Action is largely feature complete with regards to its initial goals. Find a bug or have a feature request? [Open an issue](https://github.com/benbalter/update-project-action/issues), or better yet, submit a pull request - contribution welcome!
@@ -66,6 +93,7 @@ The Action is largely feature complete with regards to its initial goals. Find a
 * `organization` - The organization that contains the project, defaults to the current repository owner
 * `project_number` - The project number from the project's URL
 * `value` - The value to set the project field to. Only required for operation type read
+* `auto_add` - Automatically add the issue or pull request to the project if it's not already in it (default: false)
 
 ### Outputs
 

__test__/main.test.ts

@@ -28,23 +28,23 @@ test("valueGraphqlType returns String for text", () => {
 });
 
 test("convertValueToFieldType converts string to number for number field", () => {
- const result = updateProject.convertValueToFieldType("42", "NUMBER");
+ const result = updateProject.convertValueToFieldType("42", "number");
  expect(result).toBe(42);
 });
 
 test("convertValueToFieldType converts string to float for number field", () => {
- const result = updateProject.convertValueToFieldType("3.14", "NUMBER");
+ const result = updateProject.convertValueToFieldType("3.14", "number");
  expect(result).toBe(3.14);
 });
 
 test("convertValueToFieldType converts zero string to number for number field", () => {
- const result = updateProject.convertValueToFieldType("0", "NUMBER");
+ const result = updateProject.convertValueToFieldType("0", "number");
  expect(result).toBe(0);
 });
 
 test("convertValueToFieldType throws error for invalid number", () => {
  expect(() => {
- updateProject.convertValueToFieldType("not-a-number", "NUMBER");
+ updateProject.convertValueToFieldType("not-a-number", "number");
  }).toThrow("Invalid number value: not-a-number");
 });
 
@@ -617,4 +617,152 @@ describe("with Octokit setup", () => {
  await updateProject.run();
  expect(mock.done()).toBe(true);
  });
+
+ test("fetchContentMetadata returns empty object when issue not in project", async () => {
+ // Mock an issue that exists but has no project items
+ const data = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [], // Empty - issue is not in any project
+ },
+ },
+ },
+ };
+ mockGraphQL(data, "contentMetadata", "projectItems");
+
+ const result = await updateProject.fetchContentMetadata(
+ "I_kwDOABCDEF1234567890",
+ "Status",
+ 9,
+ "webrecorder"
+ );
+ expect(result).toEqual({
+ notInProject: true,
+ nodeId: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ });
+ expect(mock.done()).toBe(true);
+ });
+
+ test("addProjectItem adds item to project", async () => {
+ const data = {
+ data: {
+ addProjectV2ItemById: {
+ item: {
+ id: "PVTI_lADOABCDEF4",
+ },
+ },
+ },
+ };
+ mockGraphQL(data, "addProjectItem", "addProjectV2ItemById");
+
+ const result = await updateProject.addProjectItem(
+ "PVT_kwDOABCDEF4",
+ "I_kwDOABCDEF1234567890"
+ );
+ expect(result.addProjectV2ItemById.item.id).toBe("PVTI_lADOABCDEF4");
+ expect(mock.done()).toBe(true);
+ });
+
+ test("run with auto_add when issue not in project", async () => {
+ // Set up environment with auto_add enabled
+ process.env = {
+ ...OLD_ENV,
+ ...INPUTS,
+ INPUT_AUTO_ADD: "true",
+ INPUT_CONTENT_ID: "I_kwDOABCDEF1234567890",
+ };
+
+ // Mock 1: Issue exists but not in project (first call to fetchContentMetadata)
+ const issueNotInProjectData = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [], // Empty - issue is not in any project
+ },
+ },
+ },
+ };
+ mockGraphQL(
+ issueNotInProjectData,
+ "autoAddContentMetadata1",
+ "projectItems"
+ );
+
+ // Mock 2: Project metadata for getting project ID
+ const field = {
+ id: 1,
+ name: "testField",
+ dataType: "single_select",
+ options: [
+ {
+ id: 1,
+ name: "testValue",
+ },
+ ],
+ };
+ const projectData = {
+ data: {
+ organization: {
+ projectV2: {
+ id: 1,
+ fields: {
+ nodes: [field],
+ },
+ },
+ },
+ },
+ };
+ mockGraphQL(projectData, "autoAddProjectMetadata1", "projectV2");
+
+ // Mock 3: Add item to project
+ const addItemData = {
+ data: {
+ addProjectV2ItemById: {
+ item: {
+ id: "PVTI_lADOABCDEF4",
+ },
+ },
+ },
+ };
+ mockGraphQL(addItemData, "autoAddItem", "addProjectV2ItemById");
+
+ // Mock 4: Issue now in project (second call to fetchContentMetadata)
+ const issueInProjectData = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [
+ {
+ id: "PVTI_lADOABCDEF4",
+ project: { number: 1, owner: { login: "github" } },
+ },
+ ],
+ },
+ },
+ },
+ };
+ mockGraphQL(issueInProjectData, "autoAddContentMetadata2", "projectItems");
+
+ // Mock 5: Project metadata again
+ mockGraphQL(projectData, "autoAddProjectMetadata2", "projectV2");
+
+ // Mock 6: Update field
+ const updateData = { data: { projectV2Item: { id: "PVTI_lADOABCDEF4" } } };
+ mockGraphQL(
+ updateData,
+ "autoAddUpdateField",
+ "updateProjectV2ItemFieldValue"
+ );
+
+ await updateProject.run();
+ expect(mock.done()).toBe(true);
+ });
 });

action.yml

@@ -21,6 +21,10 @@ inputs:
  value:
  description: The value to set the project field to. Only required for operation type read
  required: false
+ auto_add:
+ description: Automatically add the issue or pull request to the project if it's not already in it
+ required: false
+ default: false
  github_token:
  description: A GitHub Token with access to both the source issue and the destination project (`repo` and `write:org` scopes)
  required: true

src/update-project.ts

@@ -86,8 +86,21 @@ export async function fetchContentMetadata(
  );
  const itemTitle = result.node.title;
 
- if (!ensureExists(item, "content", `ID ${contentId}`)) {
- return {};
+ if (!item) {
+ // Check if the node exists but is not in the project
+ if (result.node && result.node.id) {
+ info(
+ `Issue/PR ${contentId} exists but is not in project ${projectNumber} for ${owner}`
+ );
+ return {
+ notInProject: true,
+ nodeId: result.node.id,
+ title: itemTitle,
+ };
+ } else {
+ setFailed(`Item not found with ID ${contentId}`);
+ return {};
+ }
  } else {
  return { ...item, title: itemTitle };
  }
@@ -222,7 +235,7 @@ export function convertValueToFieldType(
  value: string,
  fieldType: string
 ): string | number {
- if (fieldType === "NUMBER") {
+ if (fieldType === "number") {
  const numValue = parseFloat(value);
  if (isNaN(numValue)) {
  throw new Error(`Invalid number value: ${value}`);
@@ -232,6 +245,40 @@ export function convertValueToFieldType(
  return value;
 }
 
+/**
+ * Adds an issue or pull request to a project
+ * @param {string} projectId - The global ID of the project
+ * @param {string} contentId - The global ID of the issue or pull request
+ * @returns {Promise<GraphQlQueryResponseData>} - The added project item
+ */
+export async function addProjectItem(
+ projectId: string,
+ contentId: string
+): Promise<GraphQlQueryResponseData> {
+ const result: GraphQlQueryResponseData = await octokit.graphql(
+ `
+ mutation($project: ID!, $contentId: ID!) {
+ addProjectV2ItemById(
+ input: {
+ projectId: $project
+ contentId: $contentId
+ }
+ ) {
+ item {
+ id
+ }
+ }
+ }
+ `,
+ {
+ project: projectId,
+ contentId,
+ }
+ );
+
+ return result;
+}
+
 /**
  * Updates the field value for the content item
  * @param {GraphQlQueryResponseData} projectMetadata - The project metadata returned from fetchProjectMetadata()
@@ -312,6 +359,7 @@ export function getInputs(): { [key: string]: any } {
  projectNumber: parseInt(getInput("project_number", { required: true })),
  owner: getInput("organization", { required: true }),
  value: getInput("value", { required: operation === "update" }),
+ autoAdd: getInput("auto_add") === "true",
  operation,
  };
 
@@ -337,12 +385,41 @@ export async function run(): Promise<void> {
  const inputs = getInputs();
  if (Object.entries(inputs).length === 0) return;
 
-const contentMetadata = await fetchContentMetadata(
+let contentMetadata = await fetchContentMetadata(
  inputs.contentId,
  inputs.fieldName,
  inputs.projectNumber,
  inputs.owner
  );
+
+ // Check if the item is not in the project but auto_add is enabled
+ if (contentMetadata.notInProject && inputs.autoAdd) {
+ info(
+ `Auto-adding item ${inputs.contentId} to project ${inputs.projectNumber}`
+ );
+
+ // First get the project metadata to get the project ID
+ const projectMetadata = await fetchProjectMetadata(
+ inputs.owner,
+ inputs.projectNumber,
+ inputs.fieldName,
+ inputs.value,
+ inputs.operation
+ );
+ if (Object.entries(projectMetadata).length === 0) return;
+
+ // Add the item to the project
+ await addProjectItem(projectMetadata.projectId, inputs.contentId);
+
+ // Fetch the content metadata again now that it's in the project
+ contentMetadata = await fetchContentMetadata(
+ inputs.contentId,
+ inputs.fieldName,
+ inputs.projectNumber,
+ inputs.owner
+ );
+ }
+
  if (Object.entries(contentMetadata).length === 0) return;
 
  const projectMetadata = await fetchProjectMetadata(

README.md

@@ -53,6 +53,33 @@ jobs:
 
 *Note: The above step can be repeated multiple times in a given job to update multiple fields on the same or different projects.* 
 
+#### Example: Update project status when issue is assigned
+
+When using the `issues` trigger with `assigned` event, you may want to automatically add the issue to a project and set its status:
+
+```yml
+name: Update assigned issues in project
+
+on:
+ issues:
+ types: [assigned]
+
+jobs:
+ update-project-status:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Update status
+ uses: github/update-project-action@v2
+ with:
+ github_token: ${{ secrets.ACTIONS_TOKEN }}
+ organization: webrecorder
+ project_number: 9
+ content_id: ${{ github.event.issue.node_id }}
+ field: Status
+ value: Todo
+ auto_add: true # Automatically add issue to project if not already in it
+```
+
 ### Roadmap
 
 The Action is largely feature complete with regards to its initial goals. Find a bug or have a feature request? [Open an issue](https://github.com/benbalter/update-project-action/issues), or better yet, submit a pull request - contribution welcome!
@@ -66,6 +93,7 @@ The Action is largely feature complete with regards to its initial goals. Find a
 * `organization` - The organization that contains the project, defaults to the current repository owner
 * `project_number` - The project number from the project's URL
 * `value` - The value to set the project field to. Only required for operation type read
+* `auto_add` - Automatically add the issue or pull request to the project if it's not already in it (default: false)
 
 ### Outputs
 

__test__/main.test.ts

@@ -28,23 +28,23 @@ test("valueGraphqlType returns String for text", () => {
 });
 
 test("convertValueToFieldType converts string to number for number field", () => {
- const result = updateProject.convertValueToFieldType("42", "NUMBER");
+ const result = updateProject.convertValueToFieldType("42", "number");
  expect(result).toBe(42);
 });
 
 test("convertValueToFieldType converts string to float for number field", () => {
- const result = updateProject.convertValueToFieldType("3.14", "NUMBER");
+ const result = updateProject.convertValueToFieldType("3.14", "number");
  expect(result).toBe(3.14);
 });
 
 test("convertValueToFieldType converts zero string to number for number field", () => {
- const result = updateProject.convertValueToFieldType("0", "NUMBER");
+ const result = updateProject.convertValueToFieldType("0", "number");
  expect(result).toBe(0);
 });
 
 test("convertValueToFieldType throws error for invalid number", () => {
  expect(() => {
- updateProject.convertValueToFieldType("not-a-number", "NUMBER");
+ updateProject.convertValueToFieldType("not-a-number", "number");
  }).toThrow("Invalid number value: not-a-number");
 });
 
@@ -617,4 +617,152 @@ describe("with Octokit setup", () => {
  await updateProject.run();
  expect(mock.done()).toBe(true);
  });
+
+ test("fetchContentMetadata returns empty object when issue not in project", async () => {
+ // Mock an issue that exists but has no project items
+ const data = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [], // Empty - issue is not in any project
+ },
+ },
+ },
+ };
+ mockGraphQL(data, "contentMetadata", "projectItems");
+
+ const result = await updateProject.fetchContentMetadata(
+ "I_kwDOABCDEF1234567890",
+ "Status",
+ 9,
+ "webrecorder"
+ );
+ expect(result).toEqual({
+ notInProject: true,
+ nodeId: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ });
+ expect(mock.done()).toBe(true);
+ });
+
+ test("addProjectItem adds item to project", async () => {
+ const data = {
+ data: {
+ addProjectV2ItemById: {
+ item: {
+ id: "PVTI_lADOABCDEF4",
+ },
+ },
+ },
+ };
+ mockGraphQL(data, "addProjectItem", "addProjectV2ItemById");
+
+ const result = await updateProject.addProjectItem(
+ "PVT_kwDOABCDEF4",
+ "I_kwDOABCDEF1234567890"
+ );
+ expect(result.addProjectV2ItemById.item.id).toBe("PVTI_lADOABCDEF4");
+ expect(mock.done()).toBe(true);
+ });
+
+ test("run with auto_add when issue not in project", async () => {
+ // Set up environment with auto_add enabled
+ process.env = {
+ ...OLD_ENV,
+ ...INPUTS,
+ INPUT_AUTO_ADD: "true",
+ INPUT_CONTENT_ID: "I_kwDOABCDEF1234567890",
+ };
+
+ // Mock 1: Issue exists but not in project (first call to fetchContentMetadata)
+ const issueNotInProjectData = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [], // Empty - issue is not in any project
+ },
+ },
+ },
+ };
+ mockGraphQL(
+ issueNotInProjectData,
+ "autoAddContentMetadata1",
+ "projectItems"
+ );
+
+ // Mock 2: Project metadata for getting project ID
+ const field = {
+ id: 1,
+ name: "testField",
+ dataType: "single_select",
+ options: [
+ {
+ id: 1,
+ name: "testValue",
+ },
+ ],
+ };
+ const projectData = {
+ data: {
+ organization: {
+ projectV2: {
+ id: 1,
+ fields: {
+ nodes: [field],
+ },
+ },
+ },
+ },
+ };
+ mockGraphQL(projectData, "autoAddProjectMetadata1", "projectV2");
+
+ // Mock 3: Add item to project
+ const addItemData = {
+ data: {
+ addProjectV2ItemById: {
+ item: {
+ id: "PVTI_lADOABCDEF4",
+ },
+ },
+ },
+ };
+ mockGraphQL(addItemData, "autoAddItem", "addProjectV2ItemById");
+
+ // Mock 4: Issue now in project (second call to fetchContentMetadata)
+ const issueInProjectData = {
+ data: {
+ node: {
+ id: "I_kwDOABCDEF1234567890",
+ title: "Test Issue",
+ projectItems: {
+ nodes: [
+ {
+ id: "PVTI_lADOABCDEF4",
+ project: { number: 1, owner: { login: "github" } },
+ },
+ ],
+ },
+ },
+ },
+ };
+ mockGraphQL(issueInProjectData, "autoAddContentMetadata2", "projectItems");
+
+ // Mock 5: Project metadata again
+ mockGraphQL(projectData, "autoAddProjectMetadata2", "projectV2");
+
+ // Mock 6: Update field
+ const updateData = { data: { projectV2Item: { id: "PVTI_lADOABCDEF4" } } };
+ mockGraphQL(
+ updateData,
+ "autoAddUpdateField",
+ "updateProjectV2ItemFieldValue"
+ );
+
+ await updateProject.run();
+ expect(mock.done()).toBe(true);
+ });
 });

action.yml

@@ -21,6 +21,10 @@ inputs:
  value:
  description: The value to set the project field to. Only required for operation type read
  required: false
+ auto_add:
+ description: Automatically add the issue or pull request to the project if it's not already in it
+ required: false
+ default: false
  github_token:
  description: A GitHub Token with access to both the source issue and the destination project (`repo` and `write:org` scopes)
  required: true

src/update-project.ts

@@ -86,8 +86,21 @@ export async function fetchContentMetadata(
  );
  const itemTitle = result.node.title;
 
- if (!ensureExists(item, "content", `ID ${contentId}`)) {
- return {};
+ if (!item) {
+ // Check if the node exists but is not in the project
+ if (result.node && result.node.id) {
+ info(
+ `Issue/PR ${contentId} exists but is not in project ${projectNumber} for ${owner}`
+ );
+ return {
+ notInProject: true,
+ nodeId: result.node.id,
+ title: itemTitle,
+ };
+ } else {
+ setFailed(`Item not found with ID ${contentId}`);
+ return {};
+ }
  } else {
  return { ...item, title: itemTitle };
  }
@@ -222,7 +235,7 @@ export function convertValueToFieldType(
  value: string,
  fieldType: string
 ): string | number {
- if (fieldType === "NUMBER") {
+ if (fieldType === "number") {
  const numValue = parseFloat(value);
  if (isNaN(numValue)) {
  throw new Error(`Invalid number value: ${value}`);
@@ -232,6 +245,40 @@ export function convertValueToFieldType(
  return value;
 }
 
+/**
+ * Adds an issue or pull request to a project
+ * @param {string} projectId - The global ID of the project
+ * @param {string} contentId - The global ID of the issue or pull request
+ * @returns {Promise<GraphQlQueryResponseData>} - The added project item
+ */
+export async function addProjectItem(
+ projectId: string,
+ contentId: string
+): Promise<GraphQlQueryResponseData> {
+ const result: GraphQlQueryResponseData = await octokit.graphql(
+ `
+ mutation($project: ID!, $contentId: ID!) {
+ addProjectV2ItemById(
+ input: {
+ projectId: $project
+ contentId: $contentId
+ }
+ ) {
+ item {
+ id
+ }
+ }
+ }
+ `,
+ {
+ project: projectId,
+ contentId,
+ }
+ );
+
+ return result;
+}
+
 /**
  * Updates the field value for the content item
  * @param {GraphQlQueryResponseData} projectMetadata - The project metadata returned from fetchProjectMetadata()
@@ -312,6 +359,7 @@ export function getInputs(): { [key: string]: any } {
  projectNumber: parseInt(getInput("project_number", { required: true })),
  owner: getInput("organization", { required: true }),
  value: getInput("value", { required: operation === "update" }),
+ autoAdd: getInput("auto_add") === "true",
  operation,
  };
 
@@ -337,12 +385,41 @@ export async function run(): Promise<void> {
  const inputs = getInputs();
  if (Object.entries(inputs).length === 0) return;
 
-const contentMetadata = await fetchContentMetadata(
+let contentMetadata = await fetchContentMetadata(
  inputs.contentId,
  inputs.fieldName,
  inputs.projectNumber,
  inputs.owner
  );
+
+ // Check if the item is not in the project but auto_add is enabled
+ if (contentMetadata.notInProject && inputs.autoAdd) {
+ info(
+ `Auto-adding item ${inputs.contentId} to project ${inputs.projectNumber}`
+ );
+
+ // First get the project metadata to get the project ID
+ const projectMetadata = await fetchProjectMetadata(
+ inputs.owner,
+ inputs.projectNumber,
+ inputs.fieldName,
+ inputs.value,
+ inputs.operation
+ );
+ if (Object.entries(projectMetadata).length === 0) return;
+
+ // Add the item to the project
+ await addProjectItem(projectMetadata.projectId, inputs.contentId);
+
+ // Fetch the content metadata again now that it's in the project
+ contentMetadata = await fetchContentMetadata(
+ inputs.contentId,
+ inputs.fieldName,
+ inputs.projectNumber,
+ inputs.owner
+ );
+ }
+
  if (Object.entries(contentMetadata).length === 0) return;
 
  const projectMetadata = await fetchProjectMetadata(