You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-33Lines changed: 15 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,7 +62,7 @@ jobs:
62
62
63
63
Change these options in the workflow `.yml` file to meet your GitHub project needs.
64
64
65
-
| Setting | Description | Values |
65
+
| Inputs | Description | Values |
66
66
| --- | --- | --- |
67
67
| `on` | When the automation is ran | `issues` `pull_request` `issue_comment` `pull_request_target` `pull_request_review` |
68
68
| `types` | The types of activity that will trigger a workflow run. | `opened`, `assigned`, `edited`: [See GitHub docs](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request) for more |
@@ -71,39 +71,26 @@ Change these options in the workflow `.yml` file to meet your GitHub project nee
71
71
| `repo-token` | The personal access token | `${{ secrets.GITHUB_TOKEN }}` |
72
72
| `action` | This determines the type of the action to be performed on the card, Default: `update`| `update`, `delete`, `archive` |
73
73
74
-
## Personal access token (secrets.GITHUB_TOKEN)
74
+
## Personal access token
75
75
76
-
Depending on your project set up you may be able to use [`GITHUB_TOKEN`](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token) which requires no set up. This is only possible when the project and repository are owned by your account.
76
+
Most of the time [`GITHUB_TOKEN`](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token) will work as your `repo-token`. This requires no set up. If you have a public project board and public repository this is the option for you.
77
77
78
-
For forked and private repositories this error occurs:
78
+
If you are using a private repository or are using an organisation project you will need a personal access token to send events from your issues and pull requests.
79
79
80
-
```shell
81
-
GraphqlError: Resource not accessible by integration
82
-
```
83
-
84
-
**Secrets are not currently available to forks.** This error happens on forked repositories because [`GITHUB_TOKEN` only has read permissions](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token#permissions-for-the-github_token).
80
+
1. Create a personal access token
81
+
1. [Private repository and private project board](https://github.com/settings/tokens/new?scopes=repo&description=GHPROJECT_TOKEN)
82
+
1. [Organisation project board and repository](https://github.com/settings/tokens/new?scopes=repo,write:org&description=GHPROJECT_TOKEN)
85
83
86
-
On private repositories you may need to enable policy settings to allow running workflows from forks.
87
-
Please refer to GitHub's documentation to learn about enabling these settings at [enterprise](https://docs.github.com/en/free-pro-team@latest/github/setting-up-and-managing-your-enterprise-account/enforcing-github-actions-policies-in-your-enterprise-account#enabling-workflows-for-private-repository-forks), [organization](https://docs.github.com/en/free-pro-team@latest/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization?algolia-query=private+repositor#enabling-workflows-for-private-repository-forks), or [repository](https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks) level.
88
-
89
-
Alternatively, you can perform following steps:
90
-
1. Create a [personal access token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line). See the below guide on how to [configure the permissions](#permissions-for-personal-access-tokens).
91
-
2. [Create a secret](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) containing the personal access token, call it `GH_TOKEN`
92
-
3. Change the `repo-token` in the workflow `.yml` to reference your new token name:
84
+
1. [Add a secret](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) `GHPROJECT_TOKEN` with the personal access token.
85
+
1. Update the `repo-token` in the workflow `.yml` to reference your new token name:
93
86
```yaml
94
-
repo-token: ${{ secrets.GH_TOKEN }}
87
+
repo-token: ${{ secrets.GHPROJECT_TOKEN }}
95
88
```
96
89
97
-
### Permissions for personal access tokens
98
-
99
-
| Repo and project board | Permission |
100
-
| --- | --- |
101
-
| Public repository and project board | [`GITHUB_TOKEN`](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token) |
102
-
| Private repository and project board | `Full control of private repositories` |
103
-
| Organisation public or private project board and repository | `Read and write org and team membership, read and write org projects` |
104
-
105
90
## Troubleshooting
106
91
92
+
**GraphqlError: Resource not accessible by integration** and **Secrets are not currently available to forks.** This error happens on forked repositories because [`GITHUB_TOKEN` only has read permissions](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token#permissions-for-the-github_token).
93
+
107
94
**SAML enforcement**
108
95
109
96
With certain organisations there may be SAML enforcement. This means you will need to `Enable SSO` when you create the personal access token.
@@ -115,19 +102,14 @@ GraphqlError: Resource protected by organization SAML enforcement. You must gran
115
102
116
103
Make sure your permissions for your personal access token are correctly configured. Follow the above [guide on permissions](#permissions-for-personal-access-tokens).
117
104
105
+
**Private repositories**
118
106
119
-
## Local development
120
-
121
-
To set up the action for local development and testing:
122
-
123
-
1. Create a fork of the github-project-automation-plus
124
-
2. Create a new repository with a project
125
-
3. Add a workflow file that changes the `uses` to your forked repository: `uses: my-fork/github-project-automation-plus@main`
126
-
3. Make changes to your action and deploy them to GitHub
107
+
You may need to enable policy settings to allow running workflows from forks. Please refer to GitHub's documentation to learn about enabling these settings at [enterprise](https://docs.github.com/en/free-pro-team@latest/github/setting-up-and-managing-your-enterprise-account/enforcing-github-actions-policies-in-your-enterprise-account#enabling-workflows-for-private-repository-forks), [organization](https://docs.github.com/en/free-pro-team@latest/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization?algolia-query=private+repositor#enabling-workflows-for-private-repository-forks), or [repository](https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks) level.
127
108
128
109
129
110
## Release History
130
111
112
+
- v0.7.0 - Update documentation and dependencies
131
113
- v0.6.0 - Add support for `pull_request_target` and `pull_request_review`
0 commit comments