Skip to content

Commit d9f16c9

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

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
@@ -84,6 +84,36 @@ retain report artifacts for 30 days:
8484
retention: 30
8585
```
8686

87+
## Authentication
88+
89+
The GitHub Action supports multiple authentication methods to integrate with
90+
your CI workflows.
91+
92+
### GitHub App authentication (recommended)
93+
94+
For the most seamless authentication experience, we recommend installing the
95+
[Code PushUp GitHub App](https://github.com/apps/code-pushup-staging).
96+
97+
The action automatically detects the GitHub App installation and uses it for
98+
enhanced API access. This provides better security through short-lived tokens
99+
and requires zero configuration on your part.
100+
101+
### Default authentication
102+
103+
If the GitHub App is not installed, the action automatically uses the default
104+
`GITHUB_TOKEN` provided by GitHub Actions, which works perfectly for most use
105+
cases.
106+
107+
### Custom authentication
108+
109+
You can provide your own token if you have specific requirements:
110+
111+
```yml
112+
- uses: code-pushup/github-action@v0
113+
with:
114+
token: ${{ secrets.YOUR_PAT }}
115+
```
116+
87117
## Action outputs
88118

89119
Some outputs are set in case you want to add further steps to your workflow.

0 commit comments

Comments
 (0)