⛩️ Powerful yet Minimal Nix Dependency Manager
flake
flakes
home-manager
nixos
go
nix
dependency
dependencies
docs(readme): add far too much detail to tsutsumi example
+22
-3
+22
-3
README.md
+22
-3
README.md
···
72
72
To add Yae support to your Nix expression after running `yae init`, just read
73
73
from the Yae environment file.
74
74
75
-
Here's an example taken from [Tsutsumi's `zen-browser-bin` package](https://github.com/Fuwn/tsutsumi/blob/main/pkgs/zen-browser-bin.nix).
75
+
Here's an example snippet taken from Tsutsumi's [`zen-browser-bin` package](https://github.com/Fuwn/tsutsumi/blob/main/pkgs/zen-browser-bin.nix)
76
+
and [`yae.json`](https://github.com/Fuwn/tsutsumi/blob/main/yae.json#L59-L67)
77
+
showcasing Yae in action.
76
78
77
79
```nix
78
80
# pkgs/zen-browser-bin.nix
79
81
82
+
# This expression produces the `zen-browser-bin` package that Tsutsumi exposes
83
+
# as a Nix package derivation.
84
+
#
85
+
# Since it is managed by Yae, it is kept 100% up to date with zero effort through
86
+
# a Github Actions CRON job workflow that executes `yae update` periodically.
80
87
{
81
88
pkgs,
82
89
self,
90
+
# This line imports Yae's environment configuration to be used below.
83
91
yae ? builtins.fromJSON (builtins.readFile "${self}/yae.json"),
84
92
}:
93
+
# Tsutsumi exposes two versions of the Zen browser, the latest stable release
94
+
# and the latest Twilight release (a bleeding edge, daily build). This library
95
+
# function is one that takes one of two Yae sources for the Zen browser, and produces
96
+
# a Nix package derivation for it.
85
97
import "${self}/lib/zen-browser-bin.nix" {
86
-
# Effortless dependency updates just by running `yae update` from CI using a
87
-
# CRON job
98
+
# Here, the latest SHA256 hash and release version from Yae are passed to Tsutsumi's
99
+
# Zen browser packace function.
100
+
#
101
+
# If `yae update` is ran and a new release is detected, these values are
102
+
# updated by Yae, which then triggers another workflow to build and send the
103
+
# resulting derivation to Tsutsumi's binary cache.
88
104
inherit (yae.zen-browser-bin) sha256 version;
105
+
106
+
# To generate the Twilight release package, this is all that is changed.
107
+
# inherit (yae.zen-browser-twilight-bin) sha256 version;
89
108
} { inherit pkgs; }
90
109
```
91
110