https://github.com/srggrs/assign-one-project-github-action
Automatically add an issue or pull request to specific GitHub Project(s) when you create and/or label them.
https://github.com/srggrs/assign-one-project-github-action
action actions bash docker github-action github-actions github-actions-docker github-projects management organisation project project-management projects utilities utility
Last synced: about 1 month ago
JSON representation
Automatically add an issue or pull request to specific GitHub Project(s) when you create and/or label them.
- Host: GitHub
- URL: https://github.com/srggrs/assign-one-project-github-action
- Owner: srggrs
- License: mit
- Created: 2019-12-04T12:32:44.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-10-05T09:30:10.000Z (over 3 years ago)
- Last Synced: 2025-04-01T20:31:29.490Z (about 1 month ago)
- Topics: action, actions, bash, docker, github-action, github-actions, github-actions-docker, github-projects, management, organisation, project, project-management, projects, utilities, utility
- Language: Shell
- Homepage:
- Size: 53.7 KB
- Stars: 173
- Watchers: 4
- Forks: 60
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# GitHub Action for Assign to One Project
[][docker]
[][docker]
[][docker]
[][license]
[docker]: https://hub.docker.com/r/srggrs/assign-one-project-github-action
[license]: https://github.com/srggrs/assign-one-project-github-action/blob/master/LICENSE
Automatically add an issue or pull request to specific [GitHub Project](https://help.github.com/articles/about-project-boards/) when you __create__ and/or __label__ them. By default, the issues are assigned to the __`To do`__ column and the pull requests to the __`In progress`__ one, so make sure you have those columns in your project dashboard. But the workflow __allowed you to specify the column name as input__, so you can assign the issues/PRs based on a set of conditions to a specific column of a specific project.
## Latest features:
* included `issue_comment` as trigger for this action.
* added project pagination for searching 100+ GitHub projects.
## Acknowledgment & Motivations
This action has been modified from the original action from [masutaka](https://github.com/masutaka/github-actions-all-in-one-project). I needed to fix it as the original docker container would not build. Also I think the GitHub Action syntax changed a bit.
I would like to thank @SunRunAway for adding the labelling functionality and custom column input.
## Inputs
### `project`
**Required** The url of the project to be assigned to.
### `column_name`
The column name of the project, defaults to `'To do'` for issues and `'In progress'` for pull requests.
## Example usage
Examples of action:
### Repository project
```yaml
name: Auto Assign to Project(s)
on:
issues:
types: [opened, labeled]
pull_request:
types: [opened, labeled]
issue_comment:
types: [created]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
jobs:
assign_one_project:
runs-on: ubuntu-latest
name: Assign to One Project
steps:
- name: Assign NEW issues and NEW pull requests to project 2
uses: srggrs/[email protected]
if: github.event.action == 'opened'
with:
project: 'https://github.com/srggrs/assign-one-project-github-action/projects/2'
- name: Assign issues and pull requests with `bug` label to project 3
uses: srggrs/[email protected]
if: |
contains(github.event.issue.labels.*.name, 'bug') ||
contains(github.event.pull_request.labels.*.name, 'bug')
with:
project: 'https://github.com/srggrs/assign-one-project-github-action/projects/3'
column_name: 'Labeled'
```
#### __Notes__
Be careful of using the conditions above (opened and labeled issues/PRs) because in such workflow, if the issue/PR is opened and labeled at the same time, it will be assigned to __both__ projects!
You can use any combination of conditions. For example, to assign new issues or issues labeled with 'mylabel' to a project column, use:
```yaml
...
if: |
github.event_name == 'issues' &&
(
github.event.action == 'opened' ||
contains(github.event.issue.labels.*.name, 'mylabel')
)
...
```
### Organisation or User project
Generate a token from the Organisation settings or User Settings and add it as a secret in the repository secrets as `MY_GITHUB_TOKEN`
```yaml
name: Auto Assign to Project(s)
on:
issues:
types: [opened, labeled]
pull_request_target:
types: [opened, labeled]
issue_comment:
types: [created]
env:
MY_GITHUB_TOKEN: ${{ secrets.MY_GITHUB_TOKEN }}
jobs:
assign_one_project:
runs-on: ubuntu-latest
name: Assign to One Project
steps:
- name: Assign NEW issues and NEW pull requests to project 2
uses: srggrs/[email protected]
if: github.event.action == 'opened'
with:
project: 'https://github.com/srggrs/assign-one-project-github-action/projects/2'
- name: Assign issues and pull requests with `bug` label to project 3
uses: srggrs/[email protected]
if: |
contains(github.event.issue.labels.*.name, 'bug') ||
contains(github.event.pull_request.labels.*.name, 'bug')
with:
project: 'https://github.com/srggrs/assign-one-project-github-action/projects/3'
column_name: 'Labeled'
```
## [Change Log](./CHANGELOG.md)
Please refer to the list of changes [here](./CHANGELOG.md)