Skip to content

Commit ede3f82

Browse files
committed
Update documentation to reflect recent changes in enabling configuration scope at group/subgroup levels in gitlab
1 parent 5ec92b3 commit ede3f82

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

docs/docs/usage-guide/configuration_options.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Then you can give a list of extra instructions to the `review` tool.
5858

5959
## Global configuration file 💎
6060

61-
`Platforms supported: GitHub, GitLab, Bitbucket`
61+
`Platforms supported: GitHub, GitLab (cloud), Bitbucket (cloud)`
6262

6363
If you create a repo called `pr-agent-settings` in your **organization**, its configuration file `.pr_agent.toml` will be used as a global configuration file for any other repo that belongs to the same organization.
6464
Parameters from a local `.pr_agent.toml` file, in a specific repo, will override the global configuration parameters.
@@ -69,17 +69,20 @@ For example, in the GitHub organization `Codium-ai`:
6969

7070
- The repo [`https://github.com/Codium-ai/pr-agent`](https://github.com/Codium-ai/pr-agent/blob/main/.pr_agent.toml) inherits the global configuration file from `pr-agent-settings`.
7171

72-
### Bitbucket Organization level configuration file 💎
72+
## Project/Group level configuration file 💎
7373

74-
`Relevant platforms: Bitbucket Data Center`
74+
`Platforms supported: GitLab, Bitbucket Data Center`
7575

76-
In Bitbucket Data Center, there are two levels where you can define a global configuration file:
76+
Create a repository named `pr-agent-settings` within a specific project (Bitbucket) or a group/subgroup (Gitlab).
77+
The configuration file in this repository will apply to all repositories directly under the same project/group/subgroup.
7778

78-
- Project-level global configuration:
79+
!!! note "Note"
80+
For Gitlab, in case of a repository nested in several sub groups, the lookup for a pr-agent-settings repo will be only on one level above such repository.
7981

80-
Create a repository named `pr-agent-settings` within a specific project. The configuration file in this repository will apply to all repositories under the same project.
8182

82-
- Organization-level global configuration:
83+
## Organization level configuration file 💎
84+
85+
`Relevant platforms: Bitbucket Data Center`
8386

8487
Create a dedicated project to hold a global configuration file that affects all repositories across all projects in your organization.
8588

0 commit comments

Comments
 (0)