actions-marketplace-validations/Setup nixbuild.net

Setup Nix to use nixbuild.net

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Maintainedlast commit Nov 11, 2025
License
None

Pinned Snippet

workflow.ymlSHA-pinned
uses: actions-marketplace-validations/nixbuild_nixbuild-action@2de896c95167d5b9529dec0b96f4c01ee04d9624 # no releases — HEAD as of 2026-07-13

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
nixbuild_tokenThe private auth token used to access nixbuild.net. You should not add your private token directly to the workflow file but instead define a GitHub Secret for it, to avoid mistakenly sharing your token with others. Follow the instructions in the README of this action for instructions on how to create and configure your auth token. The token must have the permissions 'build:read', 'build:write', 'store:read' and 'store:write'. See https://docs.nixbuild.net/access-control/ for more details on auth tokens and permissions. yes
generate_summary_forIf set to 'job', a summary of all builds and their resource usage will be generated as a GitHub Actions step summary for the job that used nixbuild-action. If set to 'workflow', the summary will instead include builds from all jobs executed so far during the workflow run. A workflow summary makes most sense for the very last job in your workflow (since it can be incomplete otherwise). If set to '', no summary will be generated. no""
oidcIf enabled, nixbuild-action will automatically fetch an OIDC ID Token from GitHub and pass it on to nixbuild.net so that OIDC claims can be used when authoring Biscuit policies. If this setting is enabled, you must make sure your job has the 'id-token: write' permission enabled. If you want to use OIDC, but instead want fetch the token yourself, keep the 'oidc' setting off, but make sure you add the fetched token an environment variable named 'NIXBUILDNET_OIDC_ID_TOKEN' before installing nixbuild-action. The OIDC ID Token must have the audience 'nixbuild.net'. nofalse
settingsSet any nixbuild.net settings to be used for builds and requests against nixbuild.net. See https://docs.nixbuild.net/settings for available settings. You must have https://docs.nixbuild.net/settings/index.html#settings-from-ssh-env set to true (the default), otherwise the settings defined here will be ignored. Settings are defined by `<name> = <value>` pairs, one per line. An example: `max-cpu = 2` (see https://docs.nixbuild.net/settings/#max-cpu). no""
tagsSet any nixbuild.net tags to be used for builds and requests against nixbuild.net. In addition to the tags defined here, `nixbuild-action` will also add a set of tags specific to the GitHub Actions workflow run. Tags are defined by `<name> = <value>` pairs, one per line. no""
oidc_token_exchangeIf enabled in tandem with 'oidc', the action will try to exchange the OIDC token for a nixbuild.net auth token by issuing a token exchange request to nixbuild.net after fetching the OIDC token. The obtained auth token inherits the contents of the configured 'nixbuild_token', as well as the claims of the OIDC token. The new token replaces 'nixbuild_token' in subsequent requests to nixbuild.net. The new token expires after 6 hours, which is typically significantly longer than the duration of the OIDC token, which is why you may want to this enable this setting. nofalse
ssh_addressIf you are running a self-hosted nixbuild.net deployment you can set this option to the address of your SSH endpoint. noeu.nixbuild.net
ssh_portIf you are running a self-hosted nixbuild.net deployment you can set this option to the port of your SSH endpoint. no22
ssh_public_host_keyIf you are running a self-hosted nixbuild.net deployment you can set this option to the public host key of your SSH endpoint. nossh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIPIQCZc54poJ8vqawd8TraNryQeJnvH1eLpIDgbiqymM
http_api_hostIf you are running a self-hosted nixbuild.net deployment you can set this option to the host address of your HTTP API endpoint. noapi.nixbuild.net
http_api_portIf you are running a self-hosted nixbuild.net deployment you can set this option to the port your HTTP API endpoint. no443
http_api_schemeIf you are running a self-hosted nixbuild.net deployment you can set this option to the schema (http or https) of your HTTP API endpoint. nohttps
http_api_subpathIf you are running a self-hosted nixbuild.net deployment you can set this option to the subpath of your HTTP API endpoint. no""

no outputs