diff --git a/effects/flake-update/default.nix b/effects/flake-update/default.nix index 3522d7a..ef9bae7 100644 --- a/effects/flake-update/default.nix +++ b/effects/flake-update/default.nix @@ -13,7 +13,7 @@ let }; in -args@{ gitRemote +{ gitRemote , tokenSecret ? { type = "GitToken"; } , user ? "git" , updateBranch ? "flake-update" @@ -27,8 +27,7 @@ mkEffect ({ inherit (url) scheme host path; name = "flake-update"; - dontUnpack = true; - nativeBuildInputs = args.nativeBuildInputs or [ ] ++ [ + inputs = [ pkgs.git pkgs.nix ]; diff --git a/effects/flake-update/flake-module.nix b/effects/flake-update/flake-module.nix index bd75c5c..cecb199 100644 --- a/effects/flake-update/flake-module.nix +++ b/effects/flake-update/flake-module.nix @@ -1,23 +1,23 @@ { config, lib, withSystem, ... }: let inherit (lib) mkOption types optionalAttrs; - cfg = config.flake-update; + cfg = config.hercules-ci.flake-update; in { options = { - flake-update = { + hercules-ci.flake-update = { enable = lib.mkEnableOption "Scheduled flake update job"; updateBranch = mkOption { type = types.str; default = "flake-update"; example = "update"; - description = lib.mdDoc '' + description = '' To which branch to push the updated flake lock. ''; }; when = mkOption { type = types.raw; - description = lib.mdDoc '' + description = '' See `herculesCI.onSchedule..when` for details. ''; }; @@ -26,7 +26,7 @@ in default = config.defaultEffectSystem; defaultText = lib.literalExpression "config.defaultEffectSystem"; example = "aarch64-linux"; - description = lib.mdDoc '' + description = '' The [system](https://nixos.org/manual/nix/stable/command-ref/conf-file.html#conf-system) on which to run the flake update job. ''; }; diff --git a/flake-modules/herculesCI-attribute.nix b/flake-modules/herculesCI-attribute.nix index 9134ef1..a2c8443 100644 --- a/flake-modules/herculesCI-attribute.nix +++ b/flake-modules/herculesCI-attribute.nix @@ -59,7 +59,6 @@ let _Since hercules-ci-agent 0.9.8_ ''; defaultText = lib.literalMD ""; - default = throw "repo.remoteHttpUrl requires hercules-ci-agent >=0.9.8. If you run hci effect run, make sure your repository remote has an http(s) URL."; }; remoteSshUrl = mkOption { type = types.str; @@ -70,7 +69,6 @@ let _Since hercules-ci-agent 0.9.8_ ''; defaultText = lib.literalMD ""; - default = throw "repo.remoteHttpUrl requires hercules-ci-agent >=0.9.8. If you run hci effect run, make sure your repository remote has an ssh URL."; }; webUrl = mkOption { type = types.str; @@ -81,7 +79,6 @@ let _Since hercules-ci-agent 0.9.8_ ''; defaultText = lib.literalMD ""; - default = throw "repo.webUrl requires hercules-ci-agent >=0.9.8. If you run hci effect run, make sure your repository remote has an http URL."; }; forgeType = mkOption { type = types.str; @@ -95,7 +92,6 @@ let ''; example = "github"; defaultText = lib.literalMD ""; - default = throw "repo.forgeType requires hercules-ci-agent >=0.9.8."; }; owner = mkOption { type = types.str; @@ -106,7 +102,6 @@ let ''; readOnly = true; defaultText = lib.literalMD ""; - default = throw "repo.owner requires hercules-ci-agent >=0.9.8."; }; name = mkOption { type = types.str; @@ -117,7 +112,6 @@ let ''; readOnly = true; defaultText = lib.literalMD ""; - default = throw "repo.name requires hercules-ci-agent >=0.9.8."; }; }; }; @@ -232,7 +226,10 @@ let ciSystems = mkOption { type = types.listOf types.str; default = flakeParts.config.systems; - defaultText = lib.literalExpressions "config.systems # from flake parts"; + defaultText = lib.literalExpression "config.systems # from flake parts"; + description = '' + Flake systems for which to generate attributes in `herculesCI.onPush.default.outputs`. + ''; }; }; config = { diff --git a/flake-modules/module-argument.nix b/flake-modules/module-argument.nix index 0dcefcb..956bf12 100644 --- a/flake-modules/module-argument.nix +++ b/flake-modules/module-argument.nix @@ -20,12 +20,12 @@ in herculesCIEffects.pkgs = mkOption { type = types.raw or types.unspecified; description = '' - Nixpkgs instance to use for hercules-ci-effects. + Nixpkgs instance to use for `hercules-ci-effects`. - The effects functions, etc, will be provided as the effects module argument of perSystem. + The effects functions, etc, will be provided as the `effects` module argument of `perSystem`. ''; default = pkgs; - defaultText = lib.literalDocBook "pkgs (module argument)"; + defaultText = lib.literalMD "`pkgs` (module argument)"; }; }; config = {