Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peter-evans/create-or-update-project-card
A GitHub action to create or update a project card
https://github.com/peter-evans/create-or-update-project-card
automation github-action project-cards projects workflow
Last synced: 14 days ago
JSON representation
A GitHub action to create or update a project card
- Host: GitHub
- URL: https://github.com/peter-evans/create-or-update-project-card
- Owner: peter-evans
- License: mit
- Created: 2020-05-08T05:30:13.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-22T14:35:32.000Z (22 days ago)
- Last Synced: 2024-10-23T13:40:44.355Z (21 days ago)
- Topics: automation, github-action, project-cards, projects, workflow
- Language: TypeScript
- Homepage:
- Size: 2.12 MB
- Stars: 71
- Watchers: 5
- Forks: 18
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Create or Update Project Card
[](https://github.com/peter-evans/create-or-update-project-card/actions?query=workflow%3ACI)
[](https://github.com/marketplace/actions/create-or-update-project-card)
A GitHub action to create or update a project card.
> [!IMPORTANT]
> This action does not support v2 projects and is now [deprecated](https://github.com/peter-evans/create-or-update-project-card/issues/64#issuecomment-2338205349).
## Usage
### Create a project card
```yml
- 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
```
### Update a project card
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.
```yml
- 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
```
### Create a card in an organization or user project
When creating cards in an organization or user project, a `repo` and `admin:org` scoped [Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) is required.
```yml
- 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
```
### Create a card for all new issues
```yml
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
```
### Create a card for all new pull requests
Note that the following example uses the [`pull_request_target`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#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](https://docs.github.com/en/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks) from forks to run without restriction. See [here](https://github.com/peter-evans/create-pull-request/blob/main/docs/concepts-guidelines.md#restrictions-on-repository-forks) for further explanation.
```yml
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 }}
```
### Action inputs
| Name | Description | Default |
| --- | --- | --- |
| `token` | `GITHUB_TOKEN` or a `repo` scoped [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). | `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` |
### Action outputs
The action outputs `card-id` for use in later workflow steps.
```yml
- 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 }}
```
## License
[MIT](LICENSE)