woodpecker-plugin-nix-attic/docs.md
Gabor Pihaj 2bf013c916
docs: update docs + add plugin metadata (#15)
Reviewed-on: https://git.vdx.hu/voidcontext/woodpecker-plugin-nix-attic/pulls/15
Co-authored-by: Gabor Pihaj <gabor.pihaj@gmail.com>
Co-committed-by: Gabor Pihaj <gabor.pihaj@gmail.com>
2023-11-30 21:25:47 +00:00

44 lines
1.6 KiB
Markdown

---
name: Nix - Attic
description: Plugin for building and caching nix derivations using attic
authors: Gabor Pihaj <me@gaborpihaj.com>
tags: [woodpecker, nixos, nix, attic]
containerImage: git.vdx.hu/voidcontext/woodpecker-plugin-nix-attic
containerImageUrl: https://git.vdx.hu/voidcontext/-/packages/container/woodpecker-plugin-nix-attic
url: https://git.vdx.hu/voidcontext/woodpecker-plugin-nix-attic
---
This Woodpecker CI plugin is to build and cache nix derivations using the binary cache
[attic](https://github.com/zhaofengli/attic). The image is based on NixOS.
## Features
- nix experimental features enabled by default: commands and flakes
- preinstalled [attic-client](https://github.com/zhaofengli/attic)
## Settings
| Settings Name | Default | Description
|---------------------------|---------|--------------------------------------------
| `binary_cache` | *none* | sets the URL of the binary cache
| `binary_cache_public_key` | *none* | sets the public key of the binary cache
| `binary_cache_token` | *none* | sets the access token of the binary cache
| `script` | *none* | sets the commands / script to run
## Example configuration
```yaml
steps:
check:
image: git.vdx.hu/voidcontext/woodpecker-plugin-nix-attic
settings:
binary_cache: https://some-binary-cache.example.com
binary_cache_public_key: some-binary-cache.example.com:some-public-key
binary_cache_token:
from_secret: binary_cache_access_token
script: |
nix flake check
nix build
attic login default $PLUGIN_BINARY_CACHE_TOKEN
attic push some-cache $(nix path-info .#default)
```