diff --git a/docs/docs/usage-guide/configuration_options.md b/docs/docs/usage-guide/configuration_options.md index a65d34fb..1d671a61 100644 --- a/docs/docs/usage-guide/configuration_options.md +++ b/docs/docs/usage-guide/configuration_options.md @@ -69,3 +69,28 @@ For example, in the GitHub organization `Codium-ai`: - The file [`https://github.com/Codium-ai/pr-agent-settings/.pr_agent.toml`](https://github.com/Codium-ai/pr-agent-settings/blob/main/.pr_agent.toml) serves as a global configuration file for all the repos in the GitHub organization `Codium-ai`. - 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`. + +### Bitbucket Organization level configuration file 💎 +`Relevant platforms: Bitbucket Cloud, Bitbucket Data Center` + +In Bitbucket, there are two levels where you can define a global configuration file: + +* Project-level global configuration: + +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. + +* Organization-level global configuration: + +Create a dedicated project to hold a global configuration file that affects all repositories across all projects in your organization. + +**Setting up organization-level global configuration:** + +1. Create a new project with both the name and key: PR_AGENT_SETTINGS. +2. Inside the PR_AGENT_SETTINGS project, create a repository named pr-agent-settings. +3. In this repository, add a .pr_agent.toml configuration file—structured similarly to the global configuration file described above. + +Repositories across your entire Bitbucket organization will inherit the configuration from this file. + +!!! note "Note" + If both organization-level and project-level global settings are defined, the project-level settings will take precedence over the organization-level configuration. Additionally, parameters from a repository’s local .pr_agent.toml file will always override both global settings. +