Skip to content

Commit 537d0c5

Browse files
lfenzoDilumAluthge
andauthored
docs: added instructions to avoid 403 error when using CompatHelper with Github Workflows (#530)
Co-authored-by: Dilum Aluthge <[email protected]>
1 parent 1a3b572 commit 537d0c5

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

docs/src/index.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,18 @@ Whenever one of your package's dependencies releases a new breaking version, Com
1313
We would like to eventually add Julia support to [Dependabot](https://dependabot.com).
1414
If you would like to help with adding Julia support to Dependabot, join us in the `#dependabot` channel on the [Julia Language Slack](https://julialang.org/slack/).
1515

16-
## Installation
16+
## Usage
17+
1718
### GitHub
18-
Create a file at `.github/workflows/CompatHelper.yml` with the contents of the [CompatHelper.yml](https://github.com/JuliaRegistries/CompatHelper.jl/blob/master/.github/workflows/CompatHelper.yml) that is included in this repository.
19+
Create a file at `.github/workflows/CompatHelper.yml` with the contents of the [CompatHelper.yml](https://github.com/JuliaRegistries/CompatHelper.jl/blob/master/.github/workflows/CompatHelper.yml) that is included in this repository. If you need to use any special arguments for the `main` function, you can modify this file to add them.
20+
21+
!!! warning "Avoiding 403 Permission Error"
22+
Make sure to check the item "*Allow GitHub Actions to create and approve pull requests*" under Settings > Actions > General > Workflow Permissions in your repo. Otherwise, even with `permissions: pull-requests: write` in the `CompatHelper.yml`, CompatHelper won't be able to create pull requests in your repo, resuting in:
23+
```
24+
remote: Permission to <your repo>.jl.git denied to github-actions[bot].
25+
fatal: unable to access '<repo url>`: The requested URL returned error: 403
26+
```
1927

20-
If you need to use any special arguments for the `main` function, you can modify this file to add them.
2128

2229
### GitLab
2330
For GitLab you will want to add CompatHelper as a job in your `.gitlab-ci.yml` file such as:

0 commit comments

Comments
 (0)