Skip to content

Commit cfcc2f3

Browse files
takanabetakanabe
committed
Update README.md
1 parent 9e6a26a commit cfcc2f3

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

‎README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,17 @@
66
[![Docker Automated build](https://img.shields.io/docker/automated/takanabe/github-actions-automate-projects.svg?logo=docker)][dockerhub]
77
[![License](https://img.shields.io/github/license/takanabe/github-actions-automate-projects.svg)][license]
88

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
9+
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
1010

1111
## Usage
1212

13-
GitHub Projects belong to organizations, repositories, and users. This GitHub action currently does not support user-based GitHub Project. Create `.github/workflows/issues.yml` file on your repository and edit like below.
13+
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.
1414

15-
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.
1615

1716
### Repository-based project
1817

1918
```yml
20-
name: Add a new GitHub Project card linked to a GitHub issue to a specified project column
19+
name: Add a new GitHub Project card linked to a GitHub issue to the specified project column
2120
on: [issues, pull_request]
2221
jobs:
2322
github-actions-automate-projects:
@@ -45,7 +44,7 @@ jobs:
4544
### Organization-based project
4645

4746
```yml
48-
name: Add a new GitHub issue to a designate project column
47+
name: Add a new GitHub issue to the specified project column
4948
on: [issues, pull_request]
5049
jobs:
5150
add-new-issues-to-project-column:
@@ -65,7 +64,8 @@ jobs:
6564
1. Replace the secret set on ${{ secrets.GITHUB_PERSONAL_TOKEN_TO_ADD_PROJECT }} to your personal GitHub token
6665
1. Create a new personal access token from https://github.com/settings/tokens
6766
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
68-
1. Replace the pesonal token name from ${{ secrets.GITHUB_PERSONAL_TOKEN_TO_ADD_PROJECT }} to ${{ secrets.YOUR_NEW_PERSONAL_TOKEN }}
67+
1. Replace the personal token name from ${{ secrets.GITHUB_PERSONAL_TOKEN_TO_ADD_PROJECT }} to ${{ secrets.YOUR_NEW_PERSONAL_TOKEN }}
68+
1. Link repositories to the project from https://github.com/orgs/organization_name/projects/1/settings/linked_repositories
6969

7070
### User-based project
7171

@@ -86,10 +86,10 @@ User-based project is not supported yet
8686

8787
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.
8888

89-
| Property name | Values | Description |
90-
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
91-
| 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) |
92-
| github.event_name | [issues](https://developer.github.com/v3/activity/events/types/#webhook-event-name-19), [pull_quests](https://developer.github.com/v3/activity/events/types/#webhook-event-name-33) | The name of the event that triggered the workflow run |
89+
| Property name | Values | Description |
90+
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
91+
| 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) |
92+
| 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 |
9393

9494
## Development
9595

0 commit comments

Comments
 (0)