Skip to content

Commit 0a4f775

Browse files
author
Alex Page
authored
Replace reserved secret GITHUB_TOKEN with GH_TOKEN in documentation (#34)
1 parent 20936df commit 0a4f775

File tree

3 files changed

+8
-7
lines changed

3 files changed

+8
-7
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
with:
3434
project: Backlog
3535
column: Triage
36-
repo-token: ${{ secrets.GITHUB_TOKEN }}
36+
repo-token: ${{ secrets.GH_TOKEN }}
3737
```
3838
3939
### .github/workflows/assigned-pulls-todo.yml
@@ -55,7 +55,7 @@ jobs:
5555
with:
5656
project: Backlog
5757
column: To do
58-
repo-token: ${{ secrets.GITHUB_TOKEN }}
58+
repo-token: ${{ secrets.GH_TOKEN }}
5959
```
6060
6161
## Workflow options
@@ -68,7 +68,7 @@ Change these options in the workflow `.yml` file to meet your GitHub project nee
6868
| `types` | The types of activity that will trigger a workflow run. | `opened`, `assigned` |
6969
| `project` | The name of the project | `Backlog` |
7070
| `column` | The column to create or move the card to | `Triage` |
71-
| `repo-token` | The personal access token | `${{ secrets.GITHUB_TOKEN }}` |
71+
| `repo-token` | The personal access token | `${{ secrets.GH_TOKEN }}` |
7272

7373

7474
## Private repositories
@@ -80,10 +80,10 @@ GraphqlError: Resource not accessible by integration
8080

8181
When this happens you will need to:
8282
1. Create a [personal access token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line)
83-
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 `GITHUB_TOKEN`
83+
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`
8484
3. Change the `repo-token` in the workflow `.yml` to reference your new token name:
8585
```yaml
86-
repo-token: ${{ secrets.GITHUB_TOKEN }}
86+
repo-token: ${{ secrets.GH_TOKEN }}
8787
```
8888

8989
With certain organisations there may be SAML enforcement. This means you will need to `Enable SSO` when you create the personal access token.
@@ -94,6 +94,7 @@ GraphqlError: Resource protected by organization SAML enforcement. You must gran
9494
9595
## Release History
9696
97+
- v0.2.3 - Replace reserved secret `GITHUB_TOKEN` with `GH_TOKEN` in documentation
9798
- v0.2.2 - Refactor add and move card logic ✨
9899
- v0.2.1 - Fix bug with move logic when card is already in project
99100
- v0.2.0 - Restructure project, add tests, change add and move logic

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ description: '🤖 Automate GitHub Project cards with any webhook event'
33
author: 'Alex Page <[email protected]>'
44
inputs:
55
repo-token:
6-
description: 'The GITHUB_TOKEN secret can be passed in using {{ secrets.GITHUB_TOKEN }}'
6+
description: 'The GH_TOKEN secret can be passed in using {{ secrets.GH_TOKEN }}'
77
required: true
88
project:
99
description: 'The name of the GitHub Project'

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "github-project-automation-plus",
3-
"version": "0.2.2",
3+
"version": "0.2.3",
44
"description": "🤖 Automate GitHub Project cards with any webhook event",
55
"private": true,
66
"main": "dist/index.js",

0 commit comments

Comments
 (0)