1this derivation will be built:2 /nix/store/9wbbhisa4yfxpc3wb33g75vmg41baaa2-treefmt-check.drv3building '/nix/store/9wbbhisa4yfxpc3wb33g75vmg41baaa2-treefmt-check.drv'4treefmt-check> treefmt v2.5.0traversed 111 files5treefmt-check> emitted 100 files for processing6treefmt-check> formatted 100 files (6 changed) in 13.107s7treefmt-check> M README.md8treefmt-check> M docs/_static/field-lists.css9treefmt-check> M docs/guides/binary-caches.md10treefmt-check> M docs/guides/gitea.md11treefmt-check> M docs/guides/github.md12treefmt-check> M docs/guides/using.md13treefmt-check> diff --git a/README.md b/README.md14treefmt-check> index d262262..6dd1b01 10064415treefmt-check> --- a/README.md16treefmt-check> +++ b/README.md17treefmt-check> @@ -25,8 +25,7 @@ time.18treefmt-check> 19treefmt-check> ## Getting Started with Buildbot Setup20treefmt-check> 21treefmt-check> -To set up Buildbot using Buildbot-nix,22treefmt-check> -read the [documentation].23treefmt-check> +To set up Buildbot using Buildbot-nix, read the [documentation].24treefmt-check> 25treefmt-check> ## Incompatibilities with the lix overlay26treefmt-check> 27treefmt-check> @@ -80,4 +79,4 @@ We have a matrix channel at28treefmt-check> For commercial support, please contact [Mic92](https://github.com/Mic92/) at29treefmt-check> joerg@thalheim.io or reach out to [Numtide](https://numtide.com/contact/).30treefmt-check> 31treefmt-check> - [documentation]: https://buildbot-nix.readthedocs.io/en/stable/32treefmt-check> +[documentation]: https://buildbot-nix.readthedocs.io/en/stable/33treefmt-check> diff --git a/docs/_static/field-lists.css b/docs/_static/field-lists.css34treefmt-check> index 55afe4f..58974f2 10064435treefmt-check> --- a/docs/_static/field-lists.css36treefmt-check> +++ b/docs/_static/field-lists.css37treefmt-check> @@ -10,29 +10,29 @@ dl.field-list {38treefmt-check> }39treefmt-check> 40treefmt-check> dl.field-list > dt {41treefmt-check> - /*font-weight: bold;*/42treefmt-check> - word-break: break-word;43treefmt-check> - margin-top: 0em;44treefmt-check> - padding-left: 0.5em;45treefmt-check> - padding-right: 5px;46treefmt-check> - font-size: var(--font-size--normal) !important;47treefmt-check> + /*font-weight: bold;*/48treefmt-check> + word-break: break-word;49treefmt-check> + margin-top: 0em;50treefmt-check> + padding-left: 0.5em;51treefmt-check> + padding-right: 5px;52treefmt-check> + font-size: var(--font-size--normal) !important;53treefmt-check> }54treefmt-check> 55treefmt-check> dl.field-list > dd > :first-child {56treefmt-check> - margin-top: 0 !important;57treefmt-check> + margin-top: 0 !important;58treefmt-check> }59treefmt-check> 60treefmt-check> dl.field-list > dd > :last-child {61treefmt-check> - margin-bottom: 0 !important;62treefmt-check> + margin-bottom: 0 !important;63treefmt-check> }64treefmt-check> 65treefmt-check> dl.field-list > dd {66treefmt-check> - padding-left: 0.5em;67treefmt-check> - margin-top: 0em;68treefmt-check> - margin-left: 0em;69treefmt-check> - margin-bottom: .25em;70treefmt-check> + padding-left: 0.5em;71treefmt-check> + margin-top: 0em;72treefmt-check> + margin-left: 0em;73treefmt-check> + margin-bottom: 0.25em;74treefmt-check> }75treefmt-check> 76treefmt-check> dl.field-list > dd a {77treefmt-check> - overflow-wrap: anywhere;78treefmt-check> + overflow-wrap: anywhere;79treefmt-check> }80treefmt-check> diff --git a/docs/guides/binary-caches.md b/docs/guides/binary-caches.md81treefmt-check> index 3af9293..a9aea63 10064482treefmt-check> --- a/docs/guides/binary-caches.md83treefmt-check> +++ b/docs/guides/binary-caches.md84treefmt-check> @@ -24,4 +24,3 @@ integrate run a systemd service as described in85treefmt-check> [this example configuration](../../examples/attic-watch-store.nix). The systemd86treefmt-check> service watches for changes in the local buildbot-nix store and uploads the87treefmt-check> contents to the attic cache.88treefmt-check> -89treefmt-check> diff --git a/docs/guides/gitea.md b/docs/guides/gitea.md90treefmt-check> index 7315054..22d6bbd 10064491treefmt-check> --- a/docs/guides/gitea.md92treefmt-check> +++ b/docs/guides/gitea.md93treefmt-check> @@ -22,8 +22,10 @@ status updates, and secure authentication.94treefmt-check> 95treefmt-check> 1. **Create an OAuth2 Application**:96treefmt-check> - Navigate to one of these locations:97treefmt-check> - - {menuselection}`Site Administration --> Applications` (for admins, applies globally)98treefmt-check> - - {menuselection}`Organization Settings --> Applications` (for organization-wide access)99treefmt-check> + - {menuselection}`Site Administration --> Applications` (for admins,100treefmt-check> + applies globally)101treefmt-check> + - {menuselection}`Organization Settings --> Applications` (for102treefmt-check> + organization-wide access)103treefmt-check> - {menuselection}`User Settings --> Applications` (for personal use)104treefmt-check> 105treefmt-check> 2. **Configure the OAuth2 app**:106treefmt-check> diff --git a/docs/guides/github.md b/docs/guides/github.md107treefmt-check> index 073cc17..dbe1ad7 100644108treefmt-check> --- a/docs/guides/github.md109treefmt-check> +++ b/docs/guides/github.md110treefmt-check> @@ -69,8 +69,8 @@ definitions:111treefmt-check> ]112treefmt-check> ```113treefmt-check> 114treefmt-check> -- `name`: The worker name (matches {nix:option}`services.buildbot-nix.worker.name`, defaults115treefmt-check> - to hostname)116treefmt-check> +- `name`: The worker name (matches117treefmt-check> + {nix:option}`services.buildbot-nix.worker.name`, defaults to hostname)118treefmt-check> - `pass`: The password (must match119treefmt-check> {nix:option}`services.buildbot-nix.worker.workerPasswordFile` contents)120treefmt-check> - `cores`: Number of CPU cores (must match the actual core count of the worker121treefmt-check> @@ -99,34 +99,32 @@ For each repository you want to build:122treefmt-check> 123treefmt-check> ## How It Works124treefmt-check> 125treefmt-check> -Authentication:126treefmt-check> -: Uses GitHub App JWT tokens for API access and installation tokens for127treefmt-check> - repository-specific operations128treefmt-check> +Authentication: : Uses GitHub App JWT tokens for API access and installation129treefmt-check> +tokens for repository-specific operations130treefmt-check> 131treefmt-check> -Project Discovery:132treefmt-check> -: Automatically discovers repositories the app has access to, filtered by topic133treefmt-check> - if configured134treefmt-check> +Project Discovery: : Automatically discovers repositories the app has access to,135treefmt-check> +filtered by topic if configured136treefmt-check> 137treefmt-check> -Webhook Management:138treefmt-check> -: Automatically creates and manages webhooks for push and pull_request events139treefmt-check> +Webhook Management: : Automatically creates and manages webhooks for push and140treefmt-check> +pull_request events141treefmt-check> 142treefmt-check> -Status Updates:143treefmt-check> -: Reports build status back to GitHub commits and pull requests144treefmt-check> +Status Updates: : Reports build status back to GitHub commits and pull requests145treefmt-check> 146treefmt-check> -Access Control:147treefmt-check> -: - Admins: Configured users can reload projects and manage builds148treefmt-check> - - Organization members: Can restart their own builds149treefmt-check> +Access Control: : - Admins: Configured users can reload projects and manage150treefmt-check> +builds151treefmt-check> +152treefmt-check> +- Organization members: Can restart their own builds153treefmt-check> 154treefmt-check> ## Troubleshooting155treefmt-check> 156treefmt-check> -Projects not appearing:157treefmt-check> -: Check that:158treefmt-check> - - The GitHub App is installed for the repository159treefmt-check> - - The repository has the configured topic (if filtering by topic)160treefmt-check> - - Reload projects manually through the Buildbot UI161treefmt-check> +Projects not appearing: : Check that:162treefmt-check> +163treefmt-check> +- The GitHub App is installed for the repository164treefmt-check> +- The repository has the configured topic (if filtering by topic)165treefmt-check> +- Reload projects manually through the Buildbot UI166treefmt-check> 167treefmt-check> -Webhooks not created:168treefmt-check> -: Verify the app has webhook write permission for the repository169treefmt-check> +Webhooks not created: : Verify the app has webhook write permission for the170treefmt-check> +repository171treefmt-check> 172treefmt-check> -Authentication issues:173treefmt-check> -: Ensure the private key file is readable by the buildbot service174treefmt-check> +Authentication issues: : Ensure the private key file is readable by the buildbot175treefmt-check> +service176treefmt-check> diff --git a/docs/guides/using.md b/docs/guides/using.md177treefmt-check> index 2cd051e..c2fd3cd 100644178treefmt-check> --- a/docs/guides/using.md179treefmt-check> +++ b/docs/guides/using.md180treefmt-check> @@ -37,24 +37,20 @@ information natively as now.181treefmt-check> ### Public182treefmt-check> 183treefmt-check> For some actions a login is required. The authentication backend is set by the184treefmt-check> -{nix:option}`services.buildbot-nix.master.authBackend` NixOS option ("github", "gitea",185treefmt-check> -"oidc", or others).186treefmt-check> +{nix:option}`services.buildbot-nix.master.authBackend` NixOS option ("github",187treefmt-check> +"gitea", "oidc", or others).188treefmt-check> 189treefmt-check> -:::{note}190treefmt-check> -You can configure both GitHub and Gitea integrations simultaneously,191treefmt-check> +:::{note} You can configure both GitHub and Gitea integrations simultaneously,192treefmt-check> regardless of which authentication backend you choose. The auth backend only193treefmt-check> -determines how users log in to the Buildbot interface.194treefmt-check> -:::195treefmt-check> +determines how users log in to the Buildbot interface. :::196treefmt-check> 197treefmt-check> We have the following two roles:198treefmt-check> 199treefmt-check> -Admins:200treefmt-check> -: - The list of admin usernames is hard-coded in the NixOS configuration.201treefmt-check> -: - admins can reload the project list202treefmt-check> +Admins: : - The list of admin usernames is hard-coded in the NixOS203treefmt-check> +configuration. : - admins can reload the project list204treefmt-check> 205treefmt-check> -Organisation member:206treefmt-check> -: - All member of the organisation where this repository is located207treefmt-check> -: - They can restart builds208treefmt-check> +Organisation member: : - All member of the organisation where this repository is209treefmt-check> +located : - They can restart builds210treefmt-check> 211treefmt-check> #### GitHub Integration212treefmt-check> 213treefmt-check> @@ -83,17 +79,17 @@ See {doc}`oidc` for configuration details.214treefmt-check> ### Fully Private215treefmt-check> 216treefmt-check> To enable fully private mode, set217treefmt-check> -{nix:option}`services.buildbot-nix.master.accessMode.fullyPrivate` to an218treefmt-check> -attrset containing the required options for fully private use, refer to the219treefmt-check> -examples and module implementation (`nix/master.nix`).220treefmt-check> +{nix:option}`services.buildbot-nix.master.accessMode.fullyPrivate` to an attrset221treefmt-check> +containing the required options for fully private use, refer to the examples and222treefmt-check> +module implementation (`nix/master.nix`).223treefmt-check> 224treefmt-check> This access mode honors the `admins` option in addition to the225treefmt-check> {nix:option}`services.buildbot-nix.master.accessMode.fullyPrivate.organisations`226treefmt-check> option. To allow access from certain organisations, you must explicitly list227treefmt-check> them.228treefmt-check> 229treefmt-check> -If you've set {nix:option}`services.buildbot-nix.master.authBackend`230treefmt-check> -previously, unset it, or you will get an error about a conflicting definitions.231treefmt-check> +If you've set {nix:option}`services.buildbot-nix.master.authBackend` previously,232treefmt-check> +unset it, or you will get an error about a conflicting definitions.233treefmt-check> `fullyPrivate` requires the `authBackend` to be set to `basichttpauth` to234treefmt-check> function (this is handled by the module, which is why you can leave it unset).235treefmt-check> For a concrete example please refer to236treefmt-check> @@ -106,59 +102,42 @@ root of whichever branch it's currently evaluating, parse it as TOML and apply237treefmt-check> the configuration specified. The following table illustrates the supported238treefmt-check> options.239treefmt-check> 240treefmt-check> -:::{confval} lock_file241treefmt-check> -:type: `str`242treefmt-check> -:default: `flake.lock`243treefmt-check> +:::{confval} lock_file :type: `str` :default: `flake.lock`244treefmt-check> 245treefmt-check> Dictates which lock file `buildbot-nix` will use when evaluating your flake.246treefmt-check> 247treefmt-check> -:example:248treefmt-check> - have multiple lockfiles, one for nixpkgs-stable, one for nixpkgs-unstable or249treefmt-check> - by default pin an input to a private repo, but have a lockfile with that250treefmt-check> - private repo replaced by a public repo for CI251treefmt-check> -:::252treefmt-check> +:example: have multiple lockfiles, one for nixpkgs-stable, one for253treefmt-check> +nixpkgs-unstable or by default pin an input to a private repo, but have a254treefmt-check> +lockfile with that private repo replaced by a public repo for CI :::255treefmt-check> 256treefmt-check> -:::{confval} attribute257treefmt-check> -:type: `str`258treefmt-check> -:default: `checks`259treefmt-check> +:::{confval} attribute :type: `str` :default: `checks`260treefmt-check> 261treefmt-check> Which attribute in the flake to evaluate and build.262treefmt-check> 263treefmt-check> -:example: using a different attribute, like `hydraJobs`264treefmt-check> -:::265treefmt-check> +:example: using a different attribute, like `hydraJobs` :::266treefmt-check> 267treefmt-check> -:::{confval} flake_dir268treefmt-check> -:type: `str`269treefmt-check> -:default: `.`270treefmt-check> -Which directory the flake is located.271treefmt-check> +:::{confval} flake_dir :type: `str` :default: `.` Which directory the flake is272treefmt-check> +located.273treefmt-check> 274treefmt-check> -:example: using a different flake, like `./tests`275treefmt-check> -:::276treefmt-check> +:example: using a different flake, like `./tests` :::277treefmt-check> 278treefmt-check> -:::{confval} effects_on_pull_requests279treefmt-check> -:type: `bool`280treefmt-check> -:default: `false`281treefmt-check> +:::{confval} effects_on_pull_requests :type: `bool` :default: `false`282treefmt-check> 283treefmt-check> -Run hercules-ci effects on pull requests.284treefmt-check> -:::285treefmt-check> +Run hercules-ci effects on pull requests. :::286treefmt-check> 287treefmt-check> -:::{confval} effects_branches288treefmt-check> -:type: `list[str]`289treefmt-check> -:default: `[]`290treefmt-check> +:::{confval} effects_branches :type: `list[str]` :default: `[]`291treefmt-check> 292treefmt-check> Glob patterns for additional branches that run effects293treefmt-check> 294treefmt-check> -:example: `["staging", "release/*"]`295treefmt-check> -:::296treefmt-check> +:example: `["staging", "release/*"]` :::297treefmt-check> 298treefmt-check> By default, effects only run on the default branch. The299treefmt-check> -{confval}`effects_branches` and {confval}`effects_on_pull_requests` settings300treefmt-check> -are always read from the **default branch's** `buildbot-nix.toml` (via `git301treefmt-check> -show`) so that pull request authors cannot grant themselves effects access.302treefmt-check> -303treefmt-check> -:::{caution}304treefmt-check> -PR effects receive the same `effects_per_repo_secrets` as default-branch305treefmt-check> -effects. A malicious PR can modify the effect code to exfiltrate these secrets.306treefmt-check> -Only enable {confval}`effects_on_pull_requests` for repositories where you307treefmt-check> -trust all contributors, or where no secrets are configured.308treefmt-check> -:::309treefmt-check> +{confval}`effects_branches` and {confval}`effects_on_pull_requests` settings are310treefmt-check> +always read from the **default branch's** `buildbot-nix.toml` (via `git311treefmt-check> +show`)312treefmt-check> +so that pull request authors cannot grant themselves effects access.313treefmt-check> +314treefmt-check> +:::{caution} PR effects receive the same `effects_per_repo_secrets` as315treefmt-check> +default-branch effects. A malicious PR can modify the effect code to exfiltrate316treefmt-check> +these secrets. Only enable {confval}`effects_on_pull_requests` for repositories317treefmt-check> +where you trust all contributors, or where no secrets are configured. :::318error: Cannot build '/nix/store/9wbbhisa4yfxpc3wb33g75vmg41baaa2-treefmt-check.drv'.319 Reason: builder failed with exit code 1.320 Output paths:321 /nix/store/i4lspfl74md8skdf1as03d8v50c20491-treefmt-check322 Last 25 log lines:323 > 324 > -:example: `["staging", "release/*"]`325 > -:::326 > +:example: `["staging", "release/*"]` :::327 > 328 > By default, effects only run on the default branch. The329 > -{confval}`effects_branches` and {confval}`effects_on_pull_requests` settings330 > -are always read from the **default branch's** `buildbot-nix.toml` (via `git331 > -show`) so that pull request authors cannot grant themselves effects access.332 > -333 > -:::{caution}334 > -PR effects receive the same `effects_per_repo_secrets` as default-branch335 > -effects. A malicious PR can modify the effect code to exfiltrate these secrets.336 > -Only enable {confval}`effects_on_pull_requests` for repositories where you337 > -trust all contributors, or where no secrets are configured.338 > -:::339 > +{confval}`effects_branches` and {confval}`effects_on_pull_requests` settings are340 > +always read from the **default branch's** `buildbot-nix.toml` (via `git341 > +show`)342 > +so that pull request authors cannot grant themselves effects access.343 > +344 > +:::{caution} PR effects receive the same `effects_per_repo_secrets` as345 > +default-branch effects. A malicious PR can modify the effect code to exfiltrate346 > +these secrets. Only enable {confval}`effects_on_pull_requests` for repositories347 > +where you trust all contributors, or where no secrets are configured. :::348 For full logs, run:349 nix log /nix/store/9wbbhisa4yfxpc3wb33g75vmg41baaa2-treefmt-check.drv