code-browser docs SETTINGS.md
1.5 kB · 37 lines
Markdown
at main

Repository settings #

How code-browser reads settings from a repository itself. The app's own settings (in its config file) are described in src/main/settings/schema.ts.

The file #

A repository MAY hold .code-browser/config.toml. The app reads its [sandbox] and [locks] tables. Nothing in it concerns reviews: tables and keys the app does not read are ignored without a warning, including version 1's [reviews] table.

The trusted branch #

The file is read from the tip of the trusted branch:

  1. the remote and branch the user names in the app's settings for this repository (repository.trusted_remote, repository.trusted_branch), if any; otherwise
  2. branch B on the repository's primary remote (repository.primary_remote, else origin), where B is the target of the remote's HEAD as reported by git ls-remote --symref <remote> HEAD and recorded by the app, at the commit most recently fetched from that remote.

If neither applies (a repository with no remote and no setting), nothing is read from the repository.

The trusted branch is never the local HEAD, a local branch or the head under review, so that a change cannot change the settings it is reviewed under.

Limits #

Settings read from a repository MUST NOT set anything the app leaves to the user's own settings. They never set export destinations, hosts, accounts, adapters or credentials (integrations/README.md §3, §8).