General

description

Short description of the repository.

Example:

general:
  description: Repository description goes here

homepage

URL with more information about the repository.

Example:

general:
  homepage: https://example.com

private

Either true to make the repository private or false to make it public.

Example:

general:
  private: false

security_and_analysis

Specify which security and analysis features to enable or disable for the repository.

Example:

general:
  security_and_analysis:
    advanced_security:
      status: enabled
    code_security:
      status: enabled
    secret_scanning:
      status: enabled
    secret_scanning_push_protection:
      status: disabled
    secret_scanning_ai_detection: 
      status: disabled
    secret_scanning_non_provider_patterns:
      status: disabled

has_issues

Either true to enable issues for this repository or false to disable them.

Example:

general:
  has_issues: false

has_projects

Either true to enable projects for this repository or false to disable them.

Example:

general:
  has_projects: false

has_wiki

Either true to enable the wiki for this repository or false to disable it.

Example:

general:
  has_wiki: false

is_template

Either true to make this repo available as a template repository or false to prevent it.

Example:

general:
  is_template: true

default_branch

Updates the default branch for this repository.

Example:

general:
  default_branch: develop

allow_squash_merge

Either true to allow squash-merging pull requests, or false to prevent squash-merging.

Example:

general:
  allow_squash_merge: true

allow_merge_commit

Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

Example:

general:
  allow_merge_commit: false

allow_rebase_merge

Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

Example:

general:
  allow_rebase_merge: false

allow_auto_merge

Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

Example:

general:
  allow_auto_merge: true

delete_branch_on_merge

Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

Example:

general:
  delete_branch_on_merge: true

allow_update_branch

Either true to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.

Example:

general:
  allow_update_branch: true

squash_merge_commit_title

Required when using squash_merge_commit_message.

The default value for a squash merge commit title:

PR_TITLE: default to the pull request's title.
COMMIT_OR_PR_TITLE: default to the commit's title (if only one commit) or the pull request's title (when more than one commit).

general:
  squash_merge_commit_title: PR_TITLE

squash_merge_commit_message

The default value for a squash merge commit message:

PR_BODY: default to the pull request's body.
COMMIT_MESSAGES: default to the branch's commit messages.
BLANK: default to a blank commit message.

general:
  squash_merge_commit_message: PR_BODY

merge_commit_title

Required when using merge_commit_message.

The default value for a merge commit title.

PR_TITLE: default to the pull request's title.
MERGE_MESSAGE: default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).

general:
  merge_commit_title: PR_TITLE

merge_commit_message

The default value for a merge commit message.

PR_TITLE: default to the pull request's title.
PR_BODY: default to the pull request's body.
BLANK: default to a blank commit message.

general:
  merge_commit_message: PR_BODY

archived

Whether to archive this repository. false will unarchive a previously archived repository.

general:
  archived: true

allow_forking

Either true to allow private forks, or false to prevent private forks.

general:
  allow_forking: false

web_commit_signoff_required

Either true to require contributors to sign off on web-based commits, or false to not require contributors to sign off on web-based commits.

general:
  web_commit_signoff_required: true