about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorArun Isaac2025-11-04 02:38:41 +0000
committerArun Isaac2025-11-04 13:36:48 +0000
commit5ab44479ccb368f50b8fa768a719abd43d189053 (patch)
treeaa6054b52190a01d3aae9ab22f5daee1a756fb65 /doc
parentde8d5a774b96976c0ed3ed529870f89fd1b4a9aa (diff)
downloadguix-forge-5ab44479ccb368f50b8fa768a719abd43d189053.tar.gz
guix-forge-5ab44479ccb368f50b8fa768a719abd43d189053.tar.lz
guix-forge-5ab44479ccb368f50b8fa768a719abd43d189053.zip
forge: Promote website CI job to its own field.
With the website CI job in its own field, we can reduce boilerplate
around installing the built website at the correct path.
Diffstat (limited to 'doc')
-rw-r--r--doc/forge.skb13
1 files changed, 9 insertions, 4 deletions
diff --git a/doc/forge.skb b/doc/forge.skb
index 1703544..de6f1bc 100644
--- a/doc/forge.skb
+++ b/doc/forge.skb
@@ -564,9 +564,11 @@ gunicorn is run in]))))))
          [File-like object representing directory to serve as the
 document root of the guix-forge web interface])
        (record-field "websites-directory"
-         [Directory containing websites for each project. Each project
-must put its website here in a subdirectory with the same name as the
-project. This is usually achieved using a CI job.])
+         [Directory containing websites for each project. Each
+project's website is put in a subdirectory with the same name as the
+project. Project websites are built by the ,(abbr :short "CI" :long
+"continuous integration") job configured in its ,(record-field-ref
+"<forge-project>" "website-ci-job").])
        (record-field "projects"
          [List of ,(record-ref "<forge-project>") objects describing
 projects managed by guix-forge]))
@@ -592,8 +594,11 @@ remote.])
 will be served at ,(samp "/<name>/") on the ,(record-field-ref
 "<forge-configuration>" "web-domain") configured in ,(record-ref
 "<forge-configuration>").])
+       (record-field "website-ci-job"
+         [,(record-ref "<forge-laminar-job>") object describing ,(abbr
+:short "CI" :long "continuous integration") job to build website])
        (record-field "ci-jobs"
-         [List of ,(record-ref "<forge-laminar-job>") objects
+         [List of other ,(record-ref "<forge-laminar-job>") objects
 describing ,(abbr :short "CI" :long "continuous integration") jobs to
 configure])
        (record-field "ci-jobs-trigger"