Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hackworthltd/nix-buildkite-plugin
A Nix plugin for Buildkite.
https://github.com/hackworthltd/nix-buildkite-plugin
buildkite nix nixpkgs
Last synced: 3 months ago
JSON representation
A Nix plugin for Buildkite.
- Host: GitHub
- URL: https://github.com/hackworthltd/nix-buildkite-plugin
- Owner: hackworthltd
- License: bsd-3-clause
- Created: 2023-07-11T08:53:02.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-25T03:10:13.000Z (4 months ago)
- Last Synced: 2024-09-28T09:04:08.007Z (4 months ago)
- Topics: buildkite, nix, nixpkgs
- Language: Nix
- Homepage:
- Size: 101 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# nix-buildkite-plugin
`nix-buildkite-plugin` is a Buildkite plugin that can take a Nix
expression that describes a set of builds and transforms them into
separate Buildkite jobs. `nix-buildkite-plugin` evaluates Nix to
create derivations and then analyses these derivations to find a
topological ordering that will ensure steps have the correct
dependencies between them.
Note: this project is a fork of [Circuithub's
`nix-buildkite-buildkite-plugin``](https://github.com/circuithub/nix-buildkite-buildkite-plugin),
and we would like to thank them for their work, without which this
project wouldn't be possible!
# Getting Started
## `jobs.nix`
First, create a `jobs.nix` file in your repository. This file will contain a
tree of all builds that you are interested in. We create this tree using nested
attrsets that eventually have leaves that are derivations.
For this example, we'll start by building the `nix-buildkite` project. Our
`jobs.nix` file is:
```nix
(import nix/flake-compat.nix).defaultNix.ciJobs
```
## `.buildkite/pipeline.yml`
Next, add a `.buildkite/pipeline.yml` file with the following contents:
```yaml
steps:
- command: nix-buildkite
label: ":nixos: :buildkite:"
plugins:
- hackworthltd/nix#v1.0.0:
file: jobs.nix
```
## Add Your Pipeline
The final step is to add your pipeline to Buildkite. See
https://buildkite.com/docs/pipelines/defining-steps#getting-started for details
on how to do this. Once you have a pipeline created, make sure that the only
step declared in the pipeline configuration in Buildkite's UI is:
```yaml
steps:
- command: buildkite-agent pipeline upload
label: ":pipeline:"
```
## Post-build hooks
The plugin accepts an optional `post-build-hook` argument, whose value
is the name (or path) of an executable that's compatible with Nix's
[post-build hook
semantics](https://nixos.org/manual/nix/stable/advanced-topics/post-build-hook.html):
```yaml
steps:
- command: nix-buildkite
label: ":nixos: :buildkite:"
plugins:
- hackworthltd/nix#v1.0.0:
file: jobs.nix
post-build-hook: /etc/nix/upload-to-cache.sh
```
When specified, the plugin will run this hook after its
`nix-instantiate` phase, and after each individual job that it
creates. This option is useful when you want to take advantage of
Nix's post-build hook feature (e.g., to upload the derivations created
by the pipeline), but you don't want to enable a system-wide
post-build hook. For example, you might only want to upload some
pipelines' outputs to your binary cache, or you might want to upload
different pipelines' outputs to different binary caches.
Note that in order to use this feature, you'll need to add the user
that the Buildkite agent runs as to `nix.trustedUsers`, as only
trusted users can run post-build hooks.
## Sit Back and Enjoy!
That's it! Following these steps should give you a working pipeline that builds
`nix-buildkite`.