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

1.4 KiB

Raw Permalink Blame History

Woodpecker plugin: nix-attic

This Woodpecker CI plugin is to build and cache nix derivations using the binary cache attic. The image is based on NixOS.

Features

nix experimental features enabled by default: commands and flakes
preinstalled attic-client

Usage

See docs.md.

How to build the image locally?

On Linux

$ nix build
$ docker load -i result

On macOS

The easiest way to build the image is using a previously built version of the image:

$ echo << EOF >> cmd.txt
nix build
nix-env -iA nixpkgs.docker-client
docker load -i result
EOF
$ docker run -it                                                                   \
  -e PLUGIN_BINARY_CACHE=https://some-binary-cache.example.com                     \
  -e PLUGIN_BINARY_CACHE_PUBLIC_KEY=some-binary-cache.example.com:some-public-keyi \
  -e PLUGIN_BINARY_CACHE_TOKEN=$ACCESS_TOKEN                                       \
  -e PLUGIN_SCRIPT="$(cat cmd.txt)"                                                \
  -v $(pwd):/opt/plugin                                                            \
  -w /opt/plugin                                                                   \
  -v /var/run/docker.sock:/var/run/docker.sock                                     \
  git.vdx.hu/voidcontext/woodpecker-plugin-nix-attic:0.1.0

1.4 KiB Raw Permalink Blame History