Add Issue/PR to Project (BETA)
➕
This GitHub action adds issues or pull requests to a Project (beta).
Usage
Create a workflow (eg: .github/workflows/on-issue-pr-open.yml). See Creating a Workflow file.
You will need a project number for input project-number. For example https://github.com/users/austenstone/projects/5 the project number is 5.
You will need to create a PAT(Personal Access Token) that has admin:org access so we can read/write to the project.
Add this PAT as a secret so we can use it as input github-token, see Creating encrypted secrets for a repository.
Organizations
If your project is part of an organization that has SAML enabled you must authorize the PAT, see Authorizing a personal access token for use with SAML single sign-on.
Example: Add Issues and PRs
name: "Add to Project"
on:
issues:
types: [opened]
pull_request:
types: [opened]
jobs:
add_to_project:
runs-on: ubuntu-latest
steps:
- uses: austenstone/project-add@main
with:
github-token: "${{ secrets.MY_TOKEN }}"
project-number: 1234
Users
For user owned projects you must provide the user input in the workflow.
with:
user: ${{ github.repository_owner }}
github-token: "${{ secrets.MY_TOKEN }}"
project-number: 1234
Add Only Issues or Only PRs
Modify the on event to be issues or pull_request or both. All activity types work.
on:
issues:
types: [opened]
Example: Add Issues Assigned to User
on:
issues:
types: [assigned]
jobs:
add_assigned_to_project:
runs-on: ubuntu-latest
name: Add issue to project (beta)
steps:
- name: "Add issue that have been assigned to austenstone to project board"
uses: austenstone/project-add@v1
if: contains(github.event.issue.assignees.*.login, 'austenstone')
with:
github-token: ${{ secrets.MY_TOKEN }}
project-number: 5
Input Settings
Various inputs are defined in action.yml:
| Name | Description | Default |
|---|---|---|
| project-number | The project number. Get this from the URL. | N/A |
| github-token | Token to use to authorize. This should be a personal access token. | ${{ github.token }} |
| organization | The organization that owns of the project. | the repository owner |
| user | The user that owns of the project. | N/A |
If you are using a user owned project board you must provide the user input.${{ github.repository_owner }} is fine if you're the owner of the repository.
Permissions
Until GitHub supports permissions for projects (beta) we will need to create a PAT(Personal Access Token) with admin:org scope.
Once support is added you we can utilize Assigning permissions to jobs and the action will default to the token ${{ github.token }}.
permissions:
repository-projects: write
Another option is to use something like tibdex/github-app-token to get a token during the workflow.
11 Sep 7, 2022
21 Sep 28, 2022
4 May 20, 2022
14 Aug 14, 2022
5.1k Dec 30, 2022
144 Dec 30, 2022
3 Nov 3, 2022
7 Dec 30, 2022
7 Dec 20, 2022
2 Sep 30, 2022
17 Dec 11, 2022
35 Dec 19, 2022
74 Dec 30, 2022
11 Dec 21, 2022
5 Jan 20, 2022
4 Nov 20, 2022
10 Dec 15, 2022
4 Sep 24, 2022
4 Oct 13, 2022