Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/austenstone/project-add
Add issues to projects (beta)
https://github.com/austenstone/project-add
actions github github-actions projects
Last synced: 2 months ago
JSON representation
Add issues to projects (beta)
- Host: GitHub
- URL: https://github.com/austenstone/project-add
- Owner: austenstone
- License: mit
- Created: 2022-03-09T00:36:44.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-08T01:00:12.000Z (almost 2 years ago)
- Last Synced: 2024-10-18T06:35:17.849Z (3 months ago)
- Topics: actions, github, github-actions, projects
- Language: TypeScript
- Homepage: https://docs.github.com/en/issues/trying-out-the-new-projects-experience
- Size: 802 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
> **Note**
> Use the official action [Add To GitHub projects](https://github.com/marketplace/actions/add-to-github-projects).
---
> **Warning**
> We deprecated the ProjectNext GraphQL API on 2022-06-20, and **we will remove the ProjectNext GraphQL API on 2022-10-01**. For more information on migrating to the new ProjectV2 GraphQL API, please see "The new GitHub Issues – June 23rd update" in the GitHub Blog. See [Using the API to manage Projects
](https://docs.github.com/en/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects).
# Add Issue/PR to Project (BETA) ➕
This GitHub [action](https://docs.github.com/en/actions) adds issues or pull requests to a [Project (beta)](https://github.com/features/issues).
## Usage
Create a workflow (eg: `.github/workflows/on-issue-pr-open.yml`). See [Creating a Workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file).
You will need a project number for input `project-number`. For example [`https://github.com/users/austenstone/projects/`*`5`*](https://github.com/users/austenstone/projects/5) the project number is *`5`*.
You will need to [create a PAT(Personal Access Token)](https://github.com/settings/tokens/new?scopes=admin:org) that has `admin:org` access so we can read/write to the project.
For user owned projects the PAT will also need to have `repo` and `project` scopes.
Add this PAT as a secret so we can use it as input `github-token`, see [Creating encrypted secrets for a repository](https://docs.github.com/en/enterprise-cloud@latest/actions/security-guides/encrypted-secrets#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](https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on).
#### Example: Add Issues and PRs
```yml
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.
```yml
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`](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issues) or [`pull_request`](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request) or both. All activity types work.
```yml
on:
issues:
types: [opened]
```
#### Example: Add Issues Assigned to User
```yml
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`](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)](https://github.com/settings/tokens/new?scopes=admin:org) with `admin:org` scope.
Once support is added you we can utilize [Assigning permissions to jobs](https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs) and the action will default to the token `${{ github.token }}`.
```yml
permissions:
repository-projects: write
```
Another option is to use something like [tibdex/github-app-token](https://github.com/tibdex/github-app-token) to get a token during the workflow.
## References
- [Automating projects (beta)](https://docs.github.com/en/enterprise-cloud@latest/issues/trying-out-the-new-projects-experience/automating-projects)
- [Example workflow authenticating with a GitHub App](https://docs.github.com/en/enterprise-cloud@latest/issues/trying-out-the-new-projects-experience/automating-projects#example-workflow-authenticating-with-a-github-app)