GitHub Action
Create or Update Project Card
A GitHub action to create or update a project card.
- name: Create or Update Project Card
uses: peter-evans/create-or-update-project-card@v3
with:
project-name: My project
column-name: My column
issue-number: 1
If a card already exists in project My project
for issue 1
, the action will check if the card is in column My second column
.
If not in the specified column, the action will move the card.
- name: Create or Update Project Card
uses: peter-evans/create-or-update-project-card@v3
with:
project-name: My project
column-name: My second column
issue-number: 1
When creating cards in an organization or user project, a repo
and admin:org
scoped Personal Access Token (PAT) is required.
- name: Create or Update Project Card
uses: peter-evans/create-or-update-project-card@v3
with:
token: ${{ secrets.PAT }}
project-location: my-org
project-name: My project
column-name: My second column
issue-number: 1
on:
issues:
types: [opened]
jobs:
createCard:
runs-on: ubuntu-latest
steps:
- name: Create or Update Project Card
uses: peter-evans/create-or-update-project-card@v3
with:
project-name: My project
column-name: My column
Note that the following example uses the pull_request_target
event, not pull_request
.
In public repositories this action does not work in pull_request
workflows when triggered by forks.
This is due to token restrictions put in place by GitHub Actions.
Private repositories can be configured to enable workflows from forks to run without restriction. See here for further explanation.
on:
pull_request_target:
types: [opened]
jobs:
createCard:
runs-on: ubuntu-latest
steps:
- name: Create or Update Project Card
uses: peter-evans/create-or-update-project-card@v3
with:
project-name: My project
column-name: My column
issue-number: ${{ github.event.number }}
Name | Description | Default |
---|---|---|
token |
GITHUB_TOKEN or a repo scoped PAT. |
GITHUB_TOKEN |
project-location |
The location of the project. Either a repository, organization, or user. | github.repository (current repository) |
project-number |
(semi-required) The number of the project. Either project-number OR project-name must be supplied. |
|
project-name |
(semi-required) The name of the project. Either project-number OR project-name must be supplied. Note that a project's name is not unique. The action will use the first matching project found. |
|
column-name |
(required) The name of the column to add a card to, or move an existing card to. | |
repository |
The GitHub repository containing the issue or pull request. | github.repository (current repository) |
issue-number |
The issue or pull request number to associate with the card. | github.event.issue.number |
The action outputs card-id
for use in later workflow steps.
- name: Create or Update Project Card
id: coupc
uses: peter-evans/create-or-update-project-card@v3
with:
project-name: My project
column-name: My column
issue-number: 1
- name: Check output
run: echo ${{ steps.coupc.outputs.card-id }}