settings.sample.yml

# frontend_url [OPTIONAL]:
#   The URL on which bert-e's frontend is accessible for the users.
#   It is used in bert-e's init messages to provide a link to the UI.
frontend_url: https://bert-e.mydomain.com/bitbucket/my_company/my_repository/bert-e/

# repository_host [MANDATORY]:
#   The git hosting provider for the repository. Either bitbucket or github.
repository_host: github

# repository_owner [MANDATORY]:
#   The name of the owner of the Bitbucket/GitHub repository to work on
#
#   (a.k.a. Bitbucket team or GitHub organization)
#
repository_owner: scality


# repository_slug [MANDATORY]:
#   The slug of the Bitbucket/GitHub repository to work on
#
repository_slug: bert-e


# robot [MANDATORY]:
#   The Bitbucket/GitHub account to use for interactions with pull requests
#
#   This user will act as the robot and will:
#   - comment pull requests to indicate the progress of the merge,
#   - merge feature branches to development/* branches.
#
#   The user must have the correct permissions in Bitbucket/GitHub
#   to allow those operations (it is typically the only user allowed
#   to merge to development/* branches).
#
#   The password associated to the account is passed on the command line.
#
robot: robot_username


# robot_email [MANDATORY]:
#   The email address of the robot
#
#   This email will be referenced in the Git merge commits created
#   by the robot.
#
robot_email: nobody@nowhere.com


# build_key [OPTIONAL]:
#   The label of the key to look for in githost commit statuses.
#   The key "github_actions" can be set to check github actions status instead of external app checks
#
#   default value: pre-merge
#
build_key: pre-merge


# required_peer_approvals [OPTIONAL]:
#   Number of approvals required in the pull-request in addition to author.
#
#   values: 0 or more
#   default value: 2
#
required_peer_approvals: 2

# need_author_approval [OPTIONAL]:
#   Pull Requests need to be approved by their authors to be merged.
#   NOT SUPPORTED ON GITHUB
#
#   values: true or false
#   default value: true
#
need_author_approval: true

# jira_account_url [OPTIONAL]:
#   The url of the Jira account.
#
#   empty: no Jira checks will be performed.
#
jira_account_url: https://my_account.atlassian.net


# jira_email [OPTIONAL]:
#   The email to use to retrieve information from Jira.
#
#   empty: no Jira checks will be performed.
#
jira_email: my_jira@email.com


# jira_keys [OPTIONAL]:
#   The list of accepted Jira keys for this project.
#
#   values: list of accepted keys
#   default value: empty
#   empty: no Jira checks will be performed.
#
jira_keys:
  - MYJIRAPROJECTKEY


# prefixes [OPTIONAL]:
#   The dictionnary of expected match between the Jira issue type
#   and branch prefix.
#
#   default value: empty
#   empty: the branch prefix is not checked.
#
prefixes:
  Story: feature
  Bug: bugfix
  Improvement: improvement
  Epic: epic


# bypass_prefixes [OPTIONAL]
#
# List of branch prefixes that are allowed and that
# automatically bypass issue tracker related checks.
#
#   default value: empty
#   accepted values: (improvement|bugfix|feature|project|documentation|dependabot)
bypass_prefixes:
  - documentation
  - dependabot


# disable_version_checks [OPTIONAL]
#
# Disable the fix_version checks when the project has jira_keys set
#
#   default value: false
#   accepted values: true or false
disable_version_checks: true


pr_author_options:
  username:
    - bypass_author_approval
    - bypass_jira_check
    - bypass_build_status
    - bypass_incompatible_branch
    - bypass_peer_approval
    - bypass_leader_approval


# admins [OPTIONAL]:
#   The list of githost accounts allowed to post privileged messages
#   to the bot
#
#   default value: empty
#   empty: no one can post privileged messages
#
# Due to GDPR constraints on Bitbucket's API an account_id needs to be
# retrieved and setted as the following:
# admins:
#   - username@account_id
#
admins:
  - username_admin_1
  # Every user setting for Bitbucket must look like the following
  - username_admin_2@557042:08898ca4-5f12-4042-9942-87e167728afd


# max_commit_diff [OPTIONAL]:
#   If > 0, the robot refuses to work on pull requests that have diverged with
#   their destination branch by more that `max_commit_diff` commits.
#
#   default value: 0 (the feature is inactive)
max_commit_diff: 100


# always_create_integration_pull_requests [OPTIONAL]:
#   Bert-E will create pull requests on integration branches by default.
#   You can set this setting to false if you don't wan't any integration
#   pull requests to be created automatically. You can then, create them on
#   demand by using the `create_pull_requests` option.
#
#   default value: true
always_create_integration_pull_requests: true


# always_create_integration_branches decides whether integration
# branches are created in automatically when a pull request is opened.
#
# Bert-e will by default automatically create them.
#
#   Set this setting to false to require users to explicitly request the creation
#   of integration branches by adding a `/create_integration_branches`
#   comment in their pull request.
#
#   The above allow to temporize the creation of those branches as
#   in the review process requested changes as expected.
#
#   default value: true
#
always_create_integration_branches: true

# required_leader_approvals [OPTIONAL]:
#   Number of leader approvals required in the pull-request in addition to author.
#   Each leader approvals count as a normal peer approval as well.
#
#   values: 0 or more; must be lower or equal to required_peer_approvals.
#   default value: 0
#
required_leader_approvals: 1


# project_leaders [OPTIONAL]:
#   The list of githost accounts which count in leader approvals count.
#
#   default value: empty; if required_leader_approvals is set, there
#                  must be a greater or equal number of handles in that
#                  list
#
# Due to GDPR constraints on Bitbucket's API an account_id needs to be
# retrieved and setted as the following:
# project_leaders:
#   - username@account_id
project_leaders:
  - username_leader_1
  # Every user setting for Bitbucket must look like the following
  - username_leader_2@557042:66898ca4-5f12-4042-9942-87e167728afd