chore: add CI checks (#8)

Rafid Bin Mostofa · web-flow · commit a891d9edcb41 · 2025-01-30T21:39:17.000+06:00
Adds basic CI checks and fixes the problematic files
already present. The tests include checks for:
  - spelling
  - inclusive language
  - broken links
  - markdown style
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -0,0 +1,35 @@
+name: Tests
+
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+
+jobs:
+  docs-check:
+    name: "Check docs"
+    uses: canonical/documentation-workflows/.github/workflows/documentation-checks.yaml@main
+    with:
+      working-directory: "docs"
+      fetch-depth: 0
+
+  markdown-lint:
+    name: "Lint Markdown"
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: DavidAnson/markdownlint-cli2-action@v19
+      with:
+        config: "docs/.sphinx/.markdownlint.json"
+        globs: |
+          **/*.{md,markdown}
+          ! docs/.sphinx/**
diff --git a/README.md b/README.md
@@ -15,6 +15,7 @@ Documentation pages for Chisel.
 ## Contribution guides
 
 Prior to contributing, you must -
+
 - read and get acquainted with the [Ubuntu Code of Conduct] and
 - sign the [Canonical contributor license agreement].
 
diff --git a/docs/.custom_wordlist.txt b/docs/.custom_wordlist.txt
@@ -2,20 +2,28 @@ AGPL
 Armored
 Levenshtein
 OpenPGP
+SBOM
+SDFs
 Starlark
 Subcommands
 ZSTD
 armor
 armored
 basename
+chiseled
+distroless
 esm
 fips
 http
 https
 jsonwall
 optimize
+recognized
+runtime
+schemas
 subcommand
 subcommands
 symlink
 ubuntu
+whitespace
 yaml
diff --git a/docs/explanation/mode-of-operation.md b/docs/explanation/mode-of-operation.md
@@ -1,4 +1,5 @@
 (chisel_mo_explanation)=
+
 # How Chisel works
 
 The purpose of Chisel is to create a minimal Ubuntu root file system comprising
diff --git a/docs/explanation/slices.md b/docs/explanation/slices.md
@@ -1,4 +1,5 @@
 (slices_explanation)=
+
 # Slices
 
 ## What are package slices?
diff --git a/docs/how-to/index.md b/docs/how-to/index.md
@@ -1,4 +1,5 @@
 (how_to_guides)=
+
 # How-to guides
 
 These guides will walk you through steps of using Chisel through its operations
diff --git a/docs/how-to/install-chisel.md b/docs/how-to/install-chisel.md
@@ -9,6 +9,7 @@ methods:
 
 
 (install_chisel_binary)=
+
 ## Install the binary
 
 We publish pre-built binaries for every version of Chisel on GitHub. To install
@@ -49,6 +50,7 @@ the latest Chisel binary:
 <!-- End: Install Chisel binary -->
 
 (install_chisel_source)=
+
 ## Install from source
 
 Alternatively, you can install the latest version of Chisel from source:
@@ -67,6 +69,7 @@ Alternatively, you can install the latest version of Chisel from source:
 
 
 (install_chisel_snap)=
+
 ## Install Snap
 
 You can also install the latest version of Chisel from the Snap store. Run the
diff --git a/docs/reference/chisel-releases/chisel.yaml.md b/docs/reference/chisel-releases/chisel.yaml.md
@@ -1,21 +1,25 @@
 (chisel_yaml_ref)=
+
 # chisel.yaml
 
 The `chisel.yaml` file defines various configuration values for Chisel,
 for a given _chisel-release_.
 
 
 (chisel_yaml_location)=
+
 ## Location
 
 The file must be placed in the root level of a {ref}`chisel-releases_ref`
 directory.
 
 
 (chisel_yaml_format_spec)=
+
 ## Format specification
 
 (chisel_yaml_format_spec_format)=
+
 ### `format`
 
 | Field    | Type     | Required | Supported values |
@@ -36,6 +40,7 @@ introduce disruptive changes to the previous formats.
 
 
 (chisel_yaml_format_spec_archives)=
+
 ### `archives`
 
 | Field      | Type     | Required |
@@ -73,6 +78,7 @@ otherwise, the archive point to the Ubuntu Pro archives listed
 
 
 (chisel_yaml_format_spec_archives_default)=
+
 ### `archives.<name>.default`
 
 | Field     | Type      | Required                                                                                            | Supported values |
@@ -93,6 +99,7 @@ so use {ref}`chisel_yaml_format_spec_archives_priority` instead.
 
 
 (chisel_yaml_format_spec_archives_version)=
+
 ### `archives.<name>.version`
 
 | Field     | Type     | Required | Supported values                                        |
@@ -105,6 +112,7 @@ the archive behaviour.
 
 
 (chisel_yaml_format_spec_archives_suites)=
+
 ### `archives.<name>.suites`
 
 | Field    | Type            | Required | Supported values                                              |
@@ -117,6 +125,7 @@ guide](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest
 
 
 (chisel_yaml_format_spec_archives_components)=
+
 ### `archives.<name>.components`
 
 | Field        | Type            | Required | Supported values                                   |
@@ -132,6 +141,7 @@ locate packages.
 
 
 (chisel_yaml_format_spec_archives_public_keys)=
+
 ### `archives.<name>.public-keys`
 
 | Field         | Type            | Required | Supported values                                                            |
@@ -144,6 +154,7 @@ file signatures. These key names must be defined in
 
 
 (chisel_yaml_format_spec_archives_priority)=
+
 ### `archives.<name>.priority`
 
 | Field      | Type      | Required                                         | Supported values                   |
@@ -156,11 +167,13 @@ available in two archives, it is fetched from the archive with higher priority,
 unless the package's slice definitions file specifies {ref}`"archive"<slice_definitions_format_archive>`.
 
 Note that:
+
 - an unspecified `priority` field **does not** yield a 0 value, and
 - two archives cannot have the same `priority` value.
 
 
 (chisel_yaml_format_spec_archives_pro)=
+
 ### `archives.<name>.pro`
 
 | Field | Type     | Required | Supported values                                 |
@@ -201,14 +214,15 @@ Although not enforced, the following `priority` values are suggested when
 ```
 
 (chisel_yaml_format_spec_public_keys)=
+
 ### `public-keys`
 
 | Field         | Type     | Required |
 | ------------- | -------- | -------- |
 | `public-keys` | `object` | Required |
 
 The top-level `public-keys` field is used to define OpenPGP public keys that are
-needed to verify the `InRelease` file signatures of the 
+needed to verify the `InRelease` file signatures of the
 {ref}`chisel_yaml_format_spec_archives`.
 
 For example:
@@ -230,6 +244,7 @@ The key names are then referenced in
 
 
 (chisel_yaml_format_spec_public_keys_id)=
+
 ### `public-keys.<name>.id`
 
 | Field | Type     | Required |
@@ -242,6 +257,7 @@ fingerprint in {ref}`chisel_yaml_format_spec_public_keys_armor`.
 
 
 (chisel_yaml_format_spec_public_keys_armor)=
+
 ### `public-keys.<name>.armor`
 
 | Field   | Type     | Required |
@@ -253,6 +269,7 @@ key.
 
 
 (chisel_yaml_example)=
+
 ## Example
 
 The following `chisel.yaml` is used in Ubuntu 24.04 (Noble) release:
diff --git a/docs/reference/chisel-releases/index.md b/docs/reference/chisel-releases/index.md
@@ -1,4 +1,5 @@
 (chisel-releases_ref)=
+
 # chisel-releases
 
 Chisel uses **slice definitions files** (aka SDFs) to define the slices of packages.
diff --git a/docs/reference/chisel-releases/slice-definitions.md b/docs/reference/chisel-releases/slice-definitions.md
diff --git a/docs/reference/cmd/cut.md b/docs/reference/cmd/cut.md
diff --git a/docs/reference/manifest.md b/docs/reference/manifest.md
diff --git a/docs/tutorial/getting-started.md b/docs/tutorial/getting-started.md

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`(chisel_mo_explanation)=`
	`2`	`+`
`2`	`3`	`# How Chisel works`
`3`	`4`
`4`	`5`	`The purpose of Chisel is to create a minimal Ubuntu root file system comprising`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`(slices_explanation)=`
	`2`	`+`
`2`	`3`	`# Slices`
`3`	`4`
`4`	`5`	`## What are package slices?`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`(how_to_guides)=`
	`2`	`+`
`2`	`3`	`# How-to guides`
`3`	`4`
`4`	`5`	`These guides will walk you through steps of using Chisel through its operations`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`(chisel-releases_ref)=`
	`2`	`+`
`2`	`3`	`# chisel-releases`
`3`	`4`
`4`	`5`	`Chisel uses slice definitions files (aka SDFs) to define the slices of packages.`