Skip to content

Commit daad9a6

Browse files
committed
Review README, moving notes on 'access_token' after params table [skip ci]
1 parent cb07200 commit daad9a6

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ automated tests.
3737
## Source Configuration
3838

3939
| Parameter | Required | Example | Description |
40-
|-----------------------------|----------|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
40+
| --------------------------- | -------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
4141
| `repository` | Yes | `itsdalmo/test-repository` | The repository to target. |
42-
| `access_token` | Yes | | A Github Access Token with repository access (required for setting status on commits). N.B. If you want github-pr-resource to work with a private repository. Set `repo:full` permissions on the access token you create on GitHub. If it is a public repository, `repo:status` is enough. When using `trusted_teams`, the `read:org` scope has to be enabled. |
42+
| `access_token` | Yes | | A Github Access Token with repository access, which is required for setting status on commits. (See also the note below about required permissions.) |
4343
| `v3_endpoint` | No | `https://api.github.com` | Endpoint to use for the V3 Github API (Restful). |
4444
| `v4_endpoint` | No | `https://api.github.com/graphql` | Endpoint to use for the V4 Github API (Graphql). |
4545
| `paths` | No | `["terraform/*/*.tf"]` | Only produce new versions if the PR includes changes to files that match one or more glob patterns or prefixes. |
@@ -57,7 +57,13 @@ automated tests.
5757
| `disable_git_lfs` | No | `true` | Disable Git LFS, skipping an attempt to convert pointers of files tracked into their corresponding objects when checked out into a working copy. |
5858
| `states` | No | `["OPEN", "MERGED"]` | The PR states to select (`OPEN`, `MERGED` or `CLOSED`). The pipeline will only trigger on pull requests matching one of the specified states. Default is ["OPEN"]. |
5959

60-
Notes:
60+
**Notes:**
61+
62+
- Required permissions for `access_token`:
63+
- if you want github-pr-resource to work with a private repository, set
64+
`repo:full` permissions on the access token you create on GitHub.
65+
- If it is a public repository, `repo:status` is enough.
66+
- When using `trusted_teams`, the `read:org` scope has to be enabled.
6167
- If `v3_endpoint` is set, `v4_endpoint` must also be set (and the other way around).
6268
- Look at the [Concourse Resources documentation](https://concourse-ci.org/resources.html#resource-webhook-token)
6369
for webhook token configuration.

0 commit comments

Comments
 (0)