milas/woodpecker-plugin-nix-attic
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: update docs + add plugin metadata (#15)

Browse source 
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>
This commit is contained in:
Gabor Pihaj 2023-11-30 21:25:47 +00:00 • committed by Gabor Pihaj
parent 36d3e46145
commit 2bf013c916
No known key found for this signature in database
GPG key ID: 7BCF5D144C6C06E3
2 changed files with 53 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -1,25 +1,16 @@
# Woodpecker plugin: nix-attic
This woodpecker plugin can be configured to use a private binary cache, and it also has
[attic-client](ihttps://github.com/zhaofengli/attic) pre-installed.
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.
## Example configuration
## Features
```yaml
steps:
check:
image: git.vdx.hu/voidcontext/woodpecker-plugin-nix-attic:0.1.0
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)
```
- nix experimental features enabled by default: commands and flakes
- preinstalled [attic-client](https://github.com/zhaofengli/attic)
## Usage
See [docs.md](docs.md).
## How to build the image locally?

44
docs.md Normal file
View file

@ -0,0 +1,44 @@
---
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)
```