Skip to content

Commit 29645b6

Browse files
authored
docs: Update documentation related to the secrets change (#76)
1 parent 0af99ed commit 29645b6

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

docs/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -54,19 +54,19 @@ jobs:
5454
permissions:
5555
pull-requests: write
5656
contents: write
57-
uses: coopnorge/github-workflow-release-drafter/.github/workflows/release-drafter-go.yaml@v0.1.0
57+
issues: write
58+
uses: coopnorge/github-workflow-release-drafter/.github/workflows/release-drafter-go.yaml@v0.6.0
5859
with:
5960
project-path: "./go-playground"
60-
secrets:
61-
GITHUB_OAUTH_TOKEN: ${{ secrets.OUR_GITHUB_TOKEN }}
61+
secrets: inherit
6262
```
6363
6464
**NOTE:** As we generally have projects inside subdirectories, we need to
6565
specify the `project-path`.
6666

6767
**NOTE:** Make sure to request permissions
6868

69-
**NOTE:** GITHUB_OAUTH_TOKEN should be supplied if you reference other
69+
**NOTE:** `secrets: inherit` should be used if you reference other
7070
internal/private repositories
7171

7272
```yaml
@@ -123,9 +123,9 @@ the workflow will add a label `patch` to the PR.
123123

124124
Required Secret:
125125

126-
| Secret | Description |
127-
| :---: | :--- |
128-
| `PERSONAL_ACCESS_TOKEN` | A GitHub personal access token with `repo` scope. (Pass: `secrets.REVIEWBOT_GITHUB_TOKEN`) |
126+
| Secret | Description |
127+
|:------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
128+
| `REVIEWBOT_GITHUB_TOKEN` | A GitHub personal access token with `repo` scope. This secret should be defined in the caller repo or at the org level. It must be inhereted in the workflow with `secrets: inherit` |
129129

130130
Supported configuration options:
131131

@@ -139,9 +139,9 @@ Supported configuration options:
139139

140140
Required Secret:
141141

142-
| Secret | Description |
143-
| :---: | :--- |
144-
| `PERSONAL_ACCESS_TOKEN` | A GitHub personal access token with `repo` scope. (Pass: `secrets.REVIEWBOT_GITHUB_TOKEN`) |
142+
| Secret | Description |
143+
|:------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
144+
| `REVIEWBOT_GITHUB_TOKEN` | A GitHub personal access token with `repo` scope. This secret should be defined in the caller repo or at the org level. It must be inhereted in the workflow with `secrets: inherit` |
145145

146146
Supported configuration options:
147147

0 commit comments

Comments
 (0)