Output Project V2 Issue Item ID

[parroty]

Hi 👋. How do you think about adding an output parameter for "Project V2 Item ID", which will be returned by addProjectV2ItemById function call?

Background

• I was trying to update some fields of the project item, after creating an issue using issue-bot with project-v2-path option.
• One approach would be to use custom actions like titoportas/update-project-fields, but it requires Item ID for the Project V2 board as an input, which will be used for updateProjectV2ItemFieldValue call.
  • https://github.com/titoportas/update-project-fields/blob/main/src/update-project-fields.ts#L212
• actions/add-to-project has itemId output, and I am wondering if the issue-bot can have similar output.
  • https://github.com/actions/add-to-project/blob/main/src/add-to-project.ts#L138

Change

• Add project-v2-issue-item-id output parameter.
  • The value is retrieved from the addProjectV2ItemById call response (addProjectV2ItemById.item.id)

Example

Workflow

name: Open Issues (Sample)
on:
  workflow_dispatch:
env:
  PROJECT_NUMBER: 1
  ORGANIZATION: xxx
  REPOSITORY: yyy
jobs:
  create:
    name: Create issues
    runs-on: ubuntu-latest
    steps:
    - name: Get token
      id: get_workflow_token
      uses: peter-murray/workflow-application-token-action@v1
      with:
        application_id: ${{ secrets.APPLICATION_ID }}
        application_private_key: ${{ secrets.APPLICATION_PRIVATE_KEY }}
    - name: Create new issue
      id: create-issue
      uses: parroty/issue-bot@with-item-id
      with:
        title: "Test Title"
        body: "Test Body"
        project-v2-path: "orgs/${{ env.ORGANIZATION }}/projects/${{ env.PROJECT_NUMBER }}"
        token: ${{ steps.get_workflow_token.outputs.token }}
    - uses: titoportas/[email protected]
      with:
        project-url: "https://github.com/orgs/${{ env.ORGANIZATION }}/projects/${{ env.PROJECT_NUMBER }}"
        github-token: ${{ steps.get_workflow_token.outputs.token }}
        item-id: ${{ steps.create-issue.outputs.project-v2-issue-item-id }}
        field-keys: "Status,Component,Size"
        field-values: "Todo,Frontend,5"

Action Logs (Exerpt)

Run parroty/issue-bot@with-item-id
...

Adding issue with node ID I_kwDXIIG0F85Ta8sL to project V2 URL: orgs/xxx/projects/1
Adding issue with node ID I_kwDXIIG0F85Ta8sL to project V2 with node ID: PVT_kwXOBg-OtM4AGxgx
New issue number: 35

Previous issue number: -1

Project V2 Issue Item Id: PVTI_lAXOBg-OtM4AGxgxzgC0P1Q

[imjohnbo]

Thank you so much! LGTM .

TIL about https://github.com/titoportas/update-project-fields and the ability to update project fields. I'd like to investigate an approach that like for issue-bot itself, but compatibility with it and other actions via this output is a great idea.