You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/installation/github.md
+39-37Lines changed: 39 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
You can use our pre-built Github Action Docker image to run PR-Agent as a Github Action.
4
4
5
-
1. Add the following file to your repository under `.github/workflows/pr_agent.yml`:
5
+
1) Add the following file to your repository under `.github/workflows/pr_agent.yml`:
6
6
7
7
```yaml
8
8
on:
@@ -46,7 +46,7 @@ jobs:
46
46
OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
47
47
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
48
48
```
49
-
2. Add the following secret to your repository under `Settings > Secrets and variables > Actions > New repository secret > Add secret`:
49
+
2) Add the following secret to your repository under `Settings > Secrets and variables > Actions > New repository secret > Add secret`:
50
50
51
51
```
52
52
Name = OPENAI_KEY
@@ -55,10 +55,10 @@ Secret = <your key>
55
55
56
56
The GITHUB_TOKEN secret is automatically created by GitHub.
57
57
58
-
3. Merge this change to your main branch.
58
+
3) Merge this change to your main branch.
59
59
When you open your next PR, you should see a comment from `github-actions` bot with a review of your PR, and instructions on how to use the rest of the tools.
60
60
61
-
4. You may configure PR-Agent by adding environment variables under the env section corresponding to any configurable property in the [configuration](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml) file. Some examples:
61
+
4) You may configure PR-Agent by adding environment variables under the env section corresponding to any configurable property in the [configuration](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml) file. Some examples:
62
62
```yaml
63
63
env:
64
64
# ... previous environment values
@@ -72,7 +72,7 @@ When you open your next PR, you should see a comment from `github-actions` bot w
72
72
## Run as a GitHub App
73
73
Allowing you to automate the review process on your private or public repositories.
74
74
75
-
1. Create a GitHub App from the [Github Developer Portal](https://docs.github.com/en/developers/apps/creating-a-github-app).
75
+
1) Create a GitHub App from the [Github Developer Portal](https://docs.github.com/en/developers/apps/creating-a-github-app).
76
76
77
77
- Set the following permissions:
78
78
- Pull requests: Read & write
@@ -84,60 +84,62 @@ Allowing you to automate the review process on your private or public repositori
84
84
- Pull request
85
85
- Push (if you need to enable triggering on PR update)
86
86
87
-
2. Generate a random secret for your app, and save it for later. For example, you can use:
87
+
2) Generate a random secret for your app, and save it for later. For example, you can use:
0 commit comments