Skip to content

Commit 9fec0b3

Browse files
takanabetakanabe
committed
Improve document based on pull_request_support
1 parent 4084723 commit 9fec0b3

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

‎README.md

+16-13
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
# add-issues-to-project-column
22

3-
![Docker Automated build](https://img.shields.io/docker/automated/takanabe/add-new-issues-to-project-column.svg?logo=docker)
4-
![License](https://img.shields.io/github/license/takanabe/add-new-issues-to-project-column.svg)
3+
[dockerhub]: https://hub.docker.com/r/takanabe/add-new-issues-to-project-column
4+
[license]: https://github.com/takanabe/add-new-issues-to-project-column/blob/master/LICENSE
55

6-
GitHub Actions adding new GitHub Issues to a specified GitHub Project column automatically :recycle:. This GitHub Action is inspired by https://github.com/masutaka/github-actions-all-in-one-project
6+
[![Docker Automated build](https://img.shields.io/docker/automated/takanabe/add-new-issues-to-project-column.svg?logo=docker)][dockerhub]
7+
[![License](https://img.shields.io/github/license/takanabe/add-new-issues-to-project-column.svg)][license]
8+
9+
GitHub Actions adding GitHub Issues & Pull requests to a specified GitHub Project column automatically :recycle:. This GitHub Action is inspired by https://github.com/masutaka/github-actions-all-in-one-project
710

811
## Usage
912

@@ -36,8 +39,8 @@ jobs:
3639
GITHUB_PROJECT_COLUMN_NAME: To do
3740
```
3841
39-
1. Replace the URL set on `GITHUB_PROJECT_URL` to the URL of your repository project to place issues
40-
1. Replace the URL set on `GITHUB_PROJECT_COLUMN_NAME` to the string which your repository project has and want to place issues
42+
1. Replace the URL set on `GITHUB_PROJECT_URL` to the URL of your repository project to place issues/pull-requests
43+
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
4144

4245
### Organization-based project
4346

@@ -57,8 +60,8 @@ jobs:
5760
GITHUB_PROJECT_COLUMN_NAME: To Do
5861
```
5962

60-
1. Replace the URL set on `GITHUB_PROJECT_URL` to the URL of your repository project to place issues
61-
1. Replace the URL set on `GITHUB_PROJECT_COLUMN_NAME` to the string which your repository project has and want to place issues
63+
1. Replace the URL set on `GITHUB_PROJECT_URL` to the URL of your repository project to place issues/pull-requests
64+
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
6265
1. Replace the secret set on ${{ secrets.GITHUB_PERSONAL_TOKEN_TO_ADD_PROJECT }} to your personal GitHub token
6366
1. Create a new personal access token from https://github.com/settings/tokens
6467
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
@@ -72,12 +75,12 @@ User-based project is not supported yet
7275

7376
### Environment variables
7477

75-
| Environment variable | Value | Description |
76-
| :------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
77-
| GITHUB_TOKEN | ${{ secrets.GITHUB_TOKEN }}, ${{ secrets.GITHUB_PERSONAL_ACCESS_TOKEN }} | An Access token to access your issues 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. |
78-
| 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 |
79-
| GITHUB_PROJECT_COLUMN_NAME | Anything (e.g: To Do) | A GitHub Project column name you want to place new issues |
80-
| DEBUG | Anything (e.g: true) | A flag to produce debug messages for this GitHub Actions if this environment variable exists |
78+
| Environment variable | Value | Description |
79+
| :------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
80+
| 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. |
81+
| 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 |
82+
| GITHUB_PROJECT_COLUMN_NAME | Anything (e.g: To Do) | A GitHub Project column name you want to place issues/pull-requests |
83+
| DEBUG | Anything (e.g: true) | A flag to produce debug messages for this GitHub Actions if this environment variable exists |
8184

8285
### Condition with contexts
8386

0 commit comments

Comments
 (0)