Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/takanabe/github-actions-automate-projects
GitHub Actions adding GitHub Issues & Pull requests to the specified GitHub Project column automatically ♻️
https://github.com/takanabe/github-actions-automate-projects
github-actions github-projects go project-management
Last synced: 3 months ago
JSON representation
GitHub Actions adding GitHub Issues & Pull requests to the specified GitHub Project column automatically ♻️
- Host: GitHub
- URL: https://github.com/takanabe/github-actions-automate-projects
- Owner: takanabe
- License: apache-2.0
- Created: 2019-05-18T05:25:15.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-05T12:06:39.000Z (almost 4 years ago)
- Last Synced: 2024-10-22T03:18:40.486Z (4 months ago)
- Topics: github-actions, github-projects, go, project-management
- Language: Go
- Homepage:
- Size: 52.7 KB
- Stars: 54
- Watchers: 4
- Forks: 12
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# github-actions-automate-projects
[dockerhub]: https://hub.docker.com/r/takanabe/github-actions-automate-projects
[license]: https://github.com/takanabe/github-actions-automate-projects/blob/master/LICENSE
[][dockerhub]
[][license]
GitHub Actions adding GitHub Issues & Pull requests to the specified GitHub Project column automatically :recycle:. This GitHub Action is inspired by https://github.com/masutaka/github-actions-all-in-one-project
## Usage
GitHub Projects belong to organizations, repositories, and users. This GitHub action currently does not support user-based GitHub Project. For any type of GitHub Projects, you need to change `GITHUB_PROJECT_URL` and `GITHUB_PROJECT_COLUMN_NAME` depending on your GitHub Project URL and column name to which you want to add new cards. Create `.github/workflows/issues.yml` file on your repository and edit like below.
### Repository-based project
```yml
name: Add a new GitHub Project card linked to a GitHub issue to the specified project column
on: [issues, pull_request]
jobs:
github-actions-automate-projects:
runs-on: ubuntu-latest
steps:
- name: add-new-issues-to-repository-based-project-column
uses: docker://takanabe/github-actions-automate-projects:v0.0.1
if: github.event_name == 'issues' && github.event.action == 'opened'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_PROJECT_URL: https://github.com/takanabe/github-actions-automate-projects/projects/1
GITHUB_PROJECT_COLUMN_NAME: To do
- name: add-new-prs-to-repository-based-project-column
uses: docker://takanabe/github-actions-automate-projects:v0.0.1
if: github.event_name == 'pull_request' && github.event.action == 'opened'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_PROJECT_URL: https://github.com/takanabe/github-actions-automate-projects/projects/1
GITHUB_PROJECT_COLUMN_NAME: To do
```
1. Replace the URL set on `GITHUB_PROJECT_URL` to the URL of your repository project to place issues/pull-requests
1. Replace the URL set on `GITHUB_PROJECT_COLUMN_NAME` to the string which your repository project has and want to place issues/pull-requests
### Organization-based project
```yml
name: Add a new GitHub issue to the specified project column
on: [issues, pull_request]
jobs:
add-new-issues-to-project-column:
runs-on: ubuntu-latest
steps:
- name: add-new-issues-to-organization-based-project-column
uses: docker://takanabe/github-actions-automate-projects:v0.0.1
if: github.event_name == 'issues' && github.event.action == 'opened'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_PERSONAL_TOKEN_TO_ADD_PROJECT }}
GITHUB_PROJECT_URL: https://github.com/orgs/organization_name/projects/1
GITHUB_PROJECT_COLUMN_NAME: To Do
```
1. Replace the URL set on `GITHUB_PROJECT_URL` to the URL of your repository project to place issues/pull-requests
1. Replace the URL set on `GITHUB_PROJECT_COLUMN_NAME` to the string which your repository project has and want to place issues/pull-requests
1. Replace the secret set on ${{ secrets.GITHUB_PERSONAL_TOKEN_TO_ADD_PROJECT }} to your personal GitHub token
1. Create a new personal access token from https://github.com/settings/tokens
1. Create a new personal access token from https://github.com/organization_name/repository_name/settings/secrets with the value of personal access token you created above
1. Replace the personal token name from ${{ secrets.GITHUB_PERSONAL_TOKEN_TO_ADD_PROJECT }} to ${{ secrets.YOUR_NEW_PERSONAL_TOKEN }}
1. Link repositories to the project from https://github.com/orgs/organization_name/projects/1/settings/linked_repositories
### User-based project
User-based project is not supported yet
## Configurations
### Docker images
Docker images for this action are automatically built when master branch is updated or new release tags are created in this repository with `latest` and corresponded tag names (e.g: `v.0.0.1`). Please use `uses: docker://takanabe/github-actions-automate-projects:v0.0.1` and `uses: docker://takanabe/github-actions-automate-projects:latest` syntax to use pre-build images for this GitHub Actions.
### Environment variables
| Environment variable | Value | Description |
| :------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| GITHUB_TOKEN | ${{ secrets.GITHUB_TOKEN }}, ${{ secrets.GITHUB_PERSONAL_ACCESS_TOKEN }} | An Access token to access your repository and projects. if you use repository-based projects, ${{ secrets.GITHUB_TOKEN }} provides appropriate access privileges to this GitHub action ([See](https://help.github.com/en/articles/virtual-environments-for-github-actions#github_token-secret)). If that is not enough, you need to pass ${{ secrets.GITHUB_PERSONAL_ACCESS_TOKEN }} by issuing personal access token with appropriate grants. |
| GITHUB_PROJECT_URL | https://github.com/username/reponame/projects/1, https://github.com/orgname/reponame/projects/1, https://github.com/orgs/orgname/projects/1 | A GitHub Project URL you want to use |
| GITHUB_PROJECT_COLUMN_NAME | Anything (e.g: To Do) | A GitHub Project column name you want to place issues/pull-requests |
| DEBUG | Anything (e.g: true) | A flag to produce debug messages for this GitHub Actions if this environment variable exists |
### Condition with contexts
You can easily detect [event contexts](https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions#github-context) and use them in if statements. Here are some lists of the useful contexts for this GitHub action.
| Property name | Values | Description |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| github.event.action | opened, closed, edited, and so on | The name of actions (references for [issues](https://developer.github.com/v3/activity/events/types/#issuesevent) and for [pull_request](https://developer.github.com/v3/activity/events/types/#pullrequestevent) |
| github.event_name | [issues](https://developer.github.com/v3/activity/events/types/#webhook-event-name-19), [pull_request](https://developer.github.com/v3/activity/events/types/#webhook-event-name-33) | The name of the event that triggered the workflow run |
## Development
### Build Docker image and update DockerHub
Change `IMAGE_NAME`, `DOCKER_REPO` and `TAG_NAME` in `Makefile` based on your DockerHub settings.
```bash
make
```
Except for `sandbox` tag, [`takanabe/github-actions-automate-projects`](https://hub.docker.com/r/takanabe/github-actions-automate-projects/tags) lists production ready Docker images matching [GitHub release tag](https://github.com/takanabe/github-actions-automate-projects/releases).
## License
[Apache 2.0](https://github.com/takanabe/github-actions-automate-projects/blob/master/LICENSE)