actions/add-to-project
Use this action to automatically add the current issue or pull request to a GitHub project. Note that this is for GitHub projects (beta), not the original GitHub projects.
Current Status
NOTE: This Action (currently) only supports auto-adding Issues to a Project which lives in the same organization as your target Repository.
Usage
See action.yml for metadata that defines the inputs, outputs, and runs configuration for this action.
For more information about workflows, see Using workflows.
Create a workflow that runs when Issues or Pull Requests are opened or labeled in your repository; this workflow also supports adding Issues to your project which are transferred into your repository. Optionally configure any filters you may want to add, such as only adding issues with certain labels, you may match labels with an AND or an OR operator.
Once you've configured your workflow, save it as a .yml file in your target Repository's .github/workflows directory.
Example Usage: Issue opened with labels bug OR needs-triage
name: Add bugs to bugs project
on:
issues:
types:
- opened
jobs:
add-to-project:
name: Add issue to project
runs-on: ubuntu-latest
steps:
- uses: actions/add-to-project@main
with:
project-url: https://github.com/orgs/<orgName>/projects/<projectNumber>
github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}
labeled: bug, needs-triage
label-operator: OR
Example Usage: Pull Requests labeled with needs-review and size/XL
name: Add needs-review and size/XL pull requests to projects
on:
pull_request:
types:
- labeled
jobs:
add-to-project:
name: Add issue to project
runs-on: ubuntu-latest
steps:
- uses: actions/add-to-project@main
with:
project-url: https://github.com/orgs/<orgName>/projects/<projectNumber>
github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}
labeled: needs-review, size/XL
label-operator: AND
Further reading and additional resources
- Inputs
- Supported Events
- How to point the action to a specific branch or commit sha
- Creating a PAT and adding it to your repository
- Development
- Publish to a distribution branch
Inputs
project-url(required) is the URL of the GitHub project to add issues to.
eg:https://github.com/orgs|users/<ownerName>/projects/<projectNumber>github-token(required) is a personal access token with therepo,write:organdread:orgscopes.
See Creating a PAT and adding it to your repository for more detailslabeled(optional) is a comma-separated list of labels used to filter applicable issues. When this key is provided, an issue must have one of the labels in the list to be added to the project. Omitting this key means that any issue will be added.label-operator(optional) is the behavior of the labels filter, eitherANDorORthat controls if the issue should be matched withalllabeledinput or any of them, default isOR.
Supported Events
Currently this action supports the following issues events:
openedtransferredlabeled
and the following pull_request events:
openedlabeled
Using these events ensure that a given issue or pull request, in the workflow's repo, is added to the specified project. If labeled input(s) are defined, then issues will only be added if they contain at least one of the labels in the list.
How to point the action to a specific branch or commit sha
Pointing to a branch name generally isn't the safest way to refer to an action, but this is how you can use this action now before we've begun creating releases.
jobs:
add-to-project:
name: Add issue to project
runs-on: ubuntu-latest
steps:
- uses: actions/add-to-project@main
with:
project-url: https://github.com/orgs/<orgName>/projects/<projectNumber>
github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}
Another option would be to point to a full commit SHA:
jobs:
add-to-project:
name: Add issue to project
runs-on: ubuntu-latest
steps:
- uses: actions/add-to-project@<commitSHA>
with:
project-url: https://github.com/orgs/<orgName>/projects/<projectNumber>
github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}
Creating a PAT and adding it to your repository
-
create a new personal access token with
repo,write:organdread:orgscopes
See Creating a personal access token for more information -
add the newly created PAT as a repository secret, this secret will be referenced by the github-token input
See Encrypted secrets for more information
Development
To get started contributing to this project, clone it and install dependencies. Note that this action runs in Node.js 16.x, so we recommend using that version of Node (see "engines" in this action's package.json for details).
> git clone https://github.com/actions/add-to-project
> cd add-to-project
> npm install
Or, use GitHub Codespaces.
See the toolkit documentation for the various packages used in building this action.
Publish to a distribution branch
Actions are run from GitHub repositories, so we check in the packaged action in the "dist/" directory.
> npm run build
> git add lib dist
> git commit -a -m "Build and package"
> git push origin releases/v1
Now, a release can be created from the branch containing the built action.
License
The scripts and documentation in this project are released under the MIT License
4 Oct 13, 2022
5 Aug 12, 2022
5 Jul 31, 2022
6 Jun 14, 2022
6 Mar 2, 2022
10 Nov 18, 2022
133 Dec 28, 2022
24 Dec 22, 2022
16 Nov 23, 2022
3 Oct 23, 2022
17 Dec 11, 2022
4 Dec 8, 2022
14 Nov 12, 2022
3 Oct 6, 2022
4 Nov 25, 2022
4 May 20, 2022
7 Dec 30, 2022
21 Sep 28, 2022