Skip to content

Commit 8a366a9

Browse files
committed
docs: document authentication methods
1 parent ae2e0d8 commit 8a366a9

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,36 @@ Example of using step outputs:
103103
echo "Artifact ID is ${{ steps.code-pushup.outputs.artifact-id }}"
104104
```
105105

106+
## Authentication
107+
108+
The GitHub Action supports multiple authentication methods to integrate with
109+
your CI workflows.
110+
111+
### GitHub App authentication (recommended)
112+
113+
For the most seamless authentication experience, we recommend installing the
114+
[Code PushUp GitHub App](https://github.com/apps/code-pushup-staging).
115+
116+
The action automatically detects the GitHub App installation and uses it for
117+
enhanced API access. This provides better security through short-lived tokens
118+
and requires zero configuration on your part.
119+
120+
### Default authentication
121+
122+
If the GitHub App is not installed, the action automatically uses the default
123+
`GITHUB_TOKEN` provided by GitHub Actions, which works perfectly for most use
124+
cases.
125+
126+
### Custom authentication
127+
128+
You can provide your own token if you have specific requirements:
129+
130+
```yml
131+
- uses: code-pushup/github-action@v0
132+
with:
133+
token: ${{ secrets.YOUR_PAT }}
134+
```
135+
106136
## Monorepo mode
107137

108138
By default, the GitHub Action assumes your repository is a standalone project.

0 commit comments

Comments
 (0)