summary refs log tree commit diff
diff options
context:
space:
mode:
-rw-r--r--Documentation/contributing/first-patch.adoc1
-rw-r--r--Documentation/development/checks.adoc18
-rw-r--r--Documentation/development/release.adoc12
-rw-r--r--Documentation/installation/binary-cache.adoc15
4 files changed, 39 insertions, 7 deletions
diff --git a/Documentation/contributing/first-patch.adoc b/Documentation/contributing/first-patch.adoc
index 13efa33..cbd08c7 100644
--- a/Documentation/contributing/first-patch.adoc
+++ b/Documentation/contributing/first-patch.adoc
@@ -25,6 +25,7 @@ The process of making changes is similar to working on any git repository.
 git checkout -b fix-docs # for example
 ----
 . Make changes in your editor.
+. Run the xref:../development/checks.adoc[checks] against your changes.
 . Stage and commit your changes:
 +
 [source,shell]
diff --git a/Documentation/development/checks.adoc b/Documentation/development/checks.adoc
new file mode 100644
index 0000000..905d5b8
--- /dev/null
+++ b/Documentation/development/checks.adoc
@@ -0,0 +1,18 @@
+= Checks
+:page-parent: Development
+
+// SPDX-FileCopyrightText: 2023 Alyssa Ross <hi@alyssa.is>
+// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
+
+As part of the release build of Spectrum, checks are run to test
+functionality, ensure conformity with code conventions, and so on.
+
+These checks are defined inside the
+https://spectrum-os.org/git/spectrum/tree/release/checks[release/checks]
+directory.  To run a check, use `nix-build`:
+
+[source,shell]
+[listing]
+nix-build -I nixpkgs=https://spectrum-os.org/git/nixpkgs/snapshot/nixpkgs-rootfs.tar.gz release/checks/shellcheck.nix
+
+Building the release/checks directory will run all checks.
diff --git a/Documentation/development/release.adoc b/Documentation/development/release.adoc
new file mode 100644
index 0000000..4ecbf03
--- /dev/null
+++ b/Documentation/development/release.adoc
@@ -0,0 +1,12 @@
+= Release Builds
+:page-parent: Development
+
+// SPDX-FileCopyrightText: 2023 Alyssa Ross <hi@alyssa.is>
+// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
+
+The https://spectrum-os.org/git/spectrum/tree/release.nix[release.nix]
+file contains everything considered to be part of a "full build" of
+Spectrum.  That is, building release.nix should build everything we'd
+like to make sure builds successfully, and everything we'd like to be
+available in the binary cache.  This includes the various Spectrum
+images for distribution, as well as the xref:checks.adoc[checks].
diff --git a/Documentation/installation/binary-cache.adoc b/Documentation/installation/binary-cache.adoc
index ab53666..1ea903b 100644
--- a/Documentation/installation/binary-cache.adoc
+++ b/Documentation/installation/binary-cache.adoc
@@ -2,7 +2,7 @@
 :page-parent: Build and Run
 :page-nav_order: 1
 
-// SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
+// SPDX-FileCopyrightText: 2022-2023 Alyssa Ross <hi@alyssa.is>
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
 
 Building Spectrum from source can take a very long time.  To avoid
@@ -11,12 +11,13 @@ an x86_64 binary cache service is available.  If configured to do so,
 Nix will download build outputs from the cache, instead of building
 them locally.
 
-Builds are run on the latest NixOS unstable on
-https://www.vultr.com/[Vultr], and are signed to ensure authenticity.
-The build infrastructure and signing key are accessible by Alyssa Ross
-and Puck Meerburg.  Storage is provided by Daniel Kuehn.  Please
-https://spectrum-os.org/participating.html[get in touch] if you
-encounter any trouble with it.
+The binary cache is populated by doing a Spectrum
+xref:../development/release.adoc[release build], on the latest NixOS
+unstable, on https://www.vultr.com/[Vultr], and are signed to ensure
+authenticity.  The build infrastructure and signing key are accessible
+by Alyssa Ross and Puck Meerburg.  Storage is provided by Daniel
+Kuehn.  Please https://spectrum-os.org/participating.html[get in
+touch] if you encounter any trouble with it.
 
 The binary cache is currently not able to provide logs, due to a
 https://github.com/NixOS/nix/pull/6051[Nix bug].