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.
NOTE: This Action (currently) only supports auto-adding Issues/Pull Requests to a Project which lives in the same organization as your target Repository.
NOTE:
⚠️ This action no longer uses the deprecated ProjectNext API. If you are looking for the old version of that action, use version v0.0.5.
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, or exclude labels with a NOT
operator.
Once you've configured your workflow, save it as a .yml
file in your target Repository's .github/workflows
directory.
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@RELEASE_VERSION
with:
project-url: https://github.com/orgs/<orgName>/projects/<projectNumber>
github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}
labeled: bug, needs-triage
label-operator: OR
name: Adds all issues that don't include the 'bug' or 'needs-triage' labels to project board
on:
issues:
types:
- opened
jobs:
add-to-project:
name: Add issue to project
runs-on: ubuntu-latest
steps:
- uses: actions/add-to-project@RELEASE_VERSION
with:
project-url: https://github.com/orgs/<orgName>/projects/<projectNumber>
github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}
labeled: bug, needs-triage
label-operator: NOT
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@RELEASE_VERSION
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
- actions/add-to-project
- License
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 withrepo
andproject
scopes. 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, eitherAND
,OR
orNOT
that controls if the issue should be matched withall
labeled
input or any of them, default isOR
.
Currently this action supports the following issues
events:
opened
transferred
labeled
and the following pull_request
events:
opened
labeled
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.
-
create a new personal access token with
repo
andproject
scopes 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
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.
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.
The scripts and documentation in this project are released under the MIT License