treefmt v2.5.0traversed 274 files emitted 230 files for processing formatted 230 files (1 changed) in 1.004s M README.md diff --git a/README.md b/README.md index 6c2ebaa..656f051 100644 --- a/README.md +++ b/README.md @@ -138,14 +138,14 @@ legacy `buildbot-nix.toml`) in the root of whichever branch it's currently evaluating, parse it as TOML and apply the configuration specified. The following table illustrates the supported options. -| | key | type | description | default | example | -| :----------------------- | :------------------------- | :---------- | :-------------------------------------------------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| lock file | `lock_file` | `str` | dictates which lock file `nixbot` will use when evaluating your flake | `flake.lock` | have multiple lockfiles, one for `nixpkgs-stable`, one for `nixpkgs-unstable` or by default pin an input to a private repo, but have a lockfile with that private repo replaced by a public repo for CI | -| attribute | `attribute` | `str` | which attribute in the flake to evaluate and build | `checks` | using a different attribute, like `hydraJobs` | -| flake_dir | `flake_dir` | `str` | which directory the flake is located | `.` | using a different flake, like `./tests` | -| effects on pull requests | `effects_on_pull_requests` | `bool` | run hercules-ci effects on pull requests | `false` | set to `true` to run effects on PRs | -| effects branches | `effects_branches` | `list[str]` | glob patterns for additional branches that run effects | `[]` | `["staging", "release/*"]` | -| legacy eval (deprecated) | `legacy_eval` | `bool` | evaluate `flake_dir#attribute` directly like buildbot-nix did: no `herculesCI`/`onPush` jobs, no build modifiers, attribute names keep their old unprefixed form | `false` | ease migration of existing repos that rely on the old attribute names; will be removed in a future release | +| | key | type | description | default | example | +| :----------------------- | :------------------------- | :---------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| lock file | `lock_file` | `str` | dictates which lock file `nixbot` will use when evaluating your flake | `flake.lock` | have multiple lockfiles, one for `nixpkgs-stable`, one for `nixpkgs-unstable` or by default pin an input to a private repo, but have a lockfile with that private repo replaced by a public repo for CI | +| attribute | `attribute` | `str` | which attribute in the flake to evaluate and build | `checks` | using a different attribute, like `hydraJobs` | +| flake_dir | `flake_dir` | `str` | which directory the flake is located | `.` | using a different flake, like `./tests` | +| effects on pull requests | `effects_on_pull_requests` | `bool` | run hercules-ci effects on pull requests | `false` | set to `true` to run effects on PRs | +| effects branches | `effects_branches` | `list[str]` | glob patterns for additional branches that run effects | `[]` | `["staging", "release/*"]` | +| legacy eval (deprecated) | `legacy_eval` | `bool` | evaluate `flake_dir#attribute` directly like buildbot-nix did: no `herculesCI`/`onPush` jobs, no build modifiers, attribute names keep their old unprefixed form | `false` | ease migration of existing repos that rely on the old attribute names; will be removed in a future release | By default, effects only run on the default branch. The `effects_branches` and `effects_on_pull_requests` settings are always read from the **default