Skip to content

Commit

Permalink
Enhancements for PullRequest Resource docs
Browse files Browse the repository at this point in the history
It seems like users may not able able to understand
how to use the `PullRequestResource` with secret configuration.

This patch updates the docs with example Task with Secret
to demonstrate how to use the PR Resource.

Fixes tektoncd#1275
  • Loading branch information
hrishin committed Sep 14, 2019
1 parent 5e3276d commit ed78271
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,15 @@ spec:
- fieldName: githubToken
secretName: github-secrets
secretKey: token
---
apiVersion: v1
kind: Secret
metadata:
name: github-secrets
type: Opaque
data:
token: github_personal_access_token_secret # in base64 encoded form
```

Params that can be added are the following:
Expand Down Expand Up @@ -402,7 +411,7 @@ provider statuses, see
#### GitHub

The Pull Request resource will look for GitHub OAuth authentication tokens in
spec secrets with a field name called `authToken`.
spec secrets with a field name called `githubToken`.

URLs should be of the form: https://github.com/tektoncd/pipelines/pulls/1

Expand Down

0 comments on commit ed78271

Please sign in to comment.