https://github.com/theintern/action-project-manager
Manage Project issues for Intern
https://github.com/theintern/action-project-manager
Last synced: 11 months ago
JSON representation
Manage Project issues for Intern
- Host: GitHub
- URL: https://github.com/theintern/action-project-manager
- Owner: theintern
- License: other
- Created: 2020-02-18T13:36:27.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-08-18T19:22:33.000Z (almost 4 years ago)
- Last Synced: 2024-12-29T05:42:12.078Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 573 KB
- Stars: 0
- Watchers: 5
- Forks: 2
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# action-project-manager
This is a GitHub Action that can be used to manage issues in a project.
## Usage
```yaml
# .github/workflows/update-issue.yaml
name: Update issue
on:
issues:
pull_request:
types: [opened, closed, reopened]
jobs:
update-issue:
runs-on: ubuntu-latest
steps:
- uses: theintern/action-project-manager@v0.1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
project: Development
auto-add: true
triage-column: Triage
triage-label: needs-triage
todo-column: To do
working-column: In progress
done-column: Done
```
## Configuration
| Property | Required | Value |
| ---------------- | -------- | ----------------------------------------------------------------------------------------------- |
| `github-token` | Yes | A GitHub API token (`GITHUB_TOKEN` is available by default) |
| `project` | Yes | The project being managed |
| `auto-add` | No | If true, all new issues are added to the project |
| `triage-column` | No | Column name for new, unassigned issues |
| `triage-label` | No | Label to apply to new issues |
| `triaged-labels` | No | A comma separated list of labels; the presence of any of them marks an issue as already-triaged |
| `todo-column` | No | Column name for triaged issues |
| `working-column` | No | Column name for in-progress issues |
| `done-column` | No | Column name for completed issues |
## How it works
Only issues should be added to a project, not PRs. Linked PRs are accessible
through the issue cards.
Note that any rule below that mentions an optional config property will only be
executed if that property is defined.
Rules:
- If `auto-add` is true, new issues will be added to `triage-column` and have
`triage-label` set, unless an issue has a label in `triaged-labels`, in which
case it will be moved to `todo-column`
- Issues in `triage-column` will be moved to `todo-column` when `triage-label`
is removed
- Issues that are in `todo-column` or `triage-column` will be moved to
`working-column` when they are assigned
- When a PR is opened that links to an issue in `triage-column` or
`todo-column`, that issue will be moved to `working-column`
- An issue in `working-column` that is unassigned with be moved to
`todo-columnn`
- Closed issues are moved to `done-column`
- Re-opened issues are moved to `working-column` if they are assigned, or to
`todo-column` if not