diff --git a/dev/flake.lock b/dev/flake.lock
index d95d808..c3d7fa4 100644
--- a/dev/flake.lock
+++ b/dev/flake.lock
@@ -20,11 +20,11 @@
"nixpkgs": "nixpkgs"
},
"locked": {
- "lastModified": 1653740649,
- "narHash": "sha256-3kZc+D03J+Uleftpdv5BuBogwkc45zvhDte/AI0BvaI=",
+ "lastModified": 1653841712,
+ "narHash": "sha256-XBF4i1MuIRAEbFpj3Z3fVaYxzNEsYapyENtw3vG+q1I=",
"owner": "hercules-ci",
"repo": "hercules-ci-effects",
- "rev": "6d99ef9727b1327ec7eb6fa2055b74bd88ea4709",
+ "rev": "e14d2131b7c81acca3904b584ac45fb72da64dd2",
"type": "github"
},
"original": {
diff --git a/site/flake-module.nix b/site/flake-module.nix
index 26ace5f..38312f0 100644
--- a/site/flake-module.nix
+++ b/site/flake-module.nix
@@ -7,6 +7,7 @@
eval = libNix.evalFlakeModule { self = { inputs = { inherit (inputs) nixpkgs; }; }; } {
imports = [
inputs.pre-commit-hooks-nix.flakeModule
+ inputs.hercules-ci-effects.flakeModule
];
};
opts = eval.options;
@@ -72,6 +73,13 @@
baseUrl = "https://github.com/hercules-ci/pre-commit-hooks.nix/blob/flakeModule";
sourcePath = inputs.pre-commit-hooks-nix;
};
+ # TODO make this a dynamic input
+ hercules_ci_effectsOptions = optionsDoc {
+ title = "hercules-ci-effects";
+ sourceName = "hercules-ci-effects";
+ baseUrl = "https://github.com/hercules-ci/hercules-ci-effects/blob/master";
+ sourcePath = inputs.hercules-ci-effects;
+ };
# pandoc
htmlBefore = ''
@@ -95,6 +103,7 @@
buildPhase = ''
( echo "$htmlBefore";
pandoc --verbose --from docbook --to html5 $coreOptions;
+ pandoc --verbose --from docbook --to html5 $hercules_ci_effectsOptions;
pandoc --verbose --from docbook --to html5 $pre_commit_hooks_nixOptions;
echo "$htmlAfter"; ) >options.html
'';
diff --git a/site/index.html b/site/index.html
index 32dd855..271133f 100644
--- a/site/index.html
+++ b/site/index.html
@@ -41,6 +41,24 @@
ChangeLog
+
+ Integrations:
+
+
+ github:hercules-ci/hercules-ci-effectsgithub:hercules-ci/pre-commit-hooks.nix/flakeModule
+
+ Write your own integration
+
+
+ For a general introduction to modules, you can read Writing Modules in the NixOS manual, though it goes into NixOS specifics quite quickly. Instead of services.<name>.*, etc, we have our own options.
+
+
+
+ Writing modules in a distributed ecosystem can be a bit different. If you're inclined to write to some other module's options, consider whether those will be loaded and whether your integration idea is always desirable. If it's not always desirable, consider splitting it off into an extra module, e.g. flakeModules.someOther. Otherwise check if it's loaded: lib.optionalAttrs (options?some.other.option). You can ask @roberth on GitHub.
+
+