technofab/nix-gitlab-ci
1
0
Fork 0
mirror of https://gitlab.com/TECHNOFAB/nix-gitlab-ci.git synced 2025-12-13 02:30:09 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: improve option descriptions

Browse source
This commit is contained in:
technofab 2025-09-02 11:12:29 +02:00
parent e7f7043012
commit cad40720a6
No known key found for this signature in database
8 changed files with 90 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

20
lib/impl/modules/pipeline.nix
View file

@ -46,7 +46,9 @@
options =
{
nix = mkOption {
description = "Nix-CI config options for this pipeline";
description = ''
Nix-GitLab-CI config options for this pipeline.
'';
type = types.submoduleWith {
modules = [pipelineConfigSubmodule];
specialArgs.rootConfig = rootConfig;
@ -54,18 +56,24 @@
default = {};
};
finalConfig = mkOption {
description = "Final config of the pipeline";
internal = true;
description = ''
Final config of the pipeline. (readonly)
'';
readOnly = true;
type = types.attrs;
};
packages = mkOption {
description = "Final packages for use in CI";
internal = true;
description = ''
Final packages for use in CI. (readonly)
'';
readOnly = true;
type = types.attrsOf types.package;
};
# jobs are nested to make distinguishing them from other keys in the ci config easier
jobs = mkOption {
description = "Jobs for this pipeline";
description = ''
Jobs for this pipeline.
'';
type = types.attrsOf (types.submoduleWith {
modules = [jobSubmodule];
specialArgs = {