Issue stratis docs 390

.github/workflows/main.yml

@@ -26,19 +26,7 @@ jobs:
       - name: Run test
         run: make -f Makefile check
 
-  ci-checks:
-    runs-on: ubuntu-latest
-    container: fedora:43  # CURRENT DEVELOPMENT ENVIRONMENT
-    steps:
-      - uses: actions/checkout@v6
-        with:
-          persist-credentials: false
-      - name: Install dependencies
-        run: dnf install -y make yamllint
-      - name: Run test
-        run: make -f Makefile yamllint
-
-  spelling-checks:
+  spelling-and-formatting-checks:
     runs-on: ubuntu-latest
     container: fedora:43  # CURRENT DEVELOPMENT ENVIRONMENT
     steps:
@@ -47,6 +35,9 @@ jobs:
           dnf install -y
           clang
           make
+          xmllint
+          which
+          yamllint
       - uses: actions/checkout@v6
         with:
           persist-credentials: false
@@ -57,5 +48,9 @@ jobs:
       - uses: baptiste0928/cargo-install@v3
         with:
           crate: typos-cli
-      - name: Run test
+      - name: Run spell check
         run: make -f Makefile check-typos
+      - name: Run format check
+        run: make -f Makefile fmt
+      - name: Run lint check
+        run: make -f Makefile yamllint

Makefile

@@ -65,9 +65,13 @@ website-copy: test-website-repo test-commit-msg clean website-distrib
 	(cd ./public; cp * -R ${WEBSITE_REPO})
 	(cd ${WEBSITE_REPO}; git add .; git commit -m "${COMMIT_MSG}")
 
+fmt:
+	(cd ./docs/dbus ; $(MAKE) fmt)
+
 .PHONY:
 	check
 	clean
+	fmt
 	pdfs
 	test-commit-msg
 	test-website-repo

docs/dbus/Makefile

@@ -9,6 +9,13 @@ check-closed-insets:
 
 check: check-closed-insets
 
+fmt:
+	xmllint --format ./blockdev.xml --output ./blockdev.xml
+	xmllint --format ./filesystem.xml --output ./filesystem.xml
+	xmllint --format ./manager.xml --output ./manager.xml
+	xmllint --format ./pool.xml --output ./pool.xml
+
 .PHONY:
 	check
 	check-closed-insets
+	fmt