docs: Check formatting in CI (#15355)

Marshall Bowers created 1 year ago

This PR adds a CI step to ensure the docs are properly formatted.

Release Notes:

- N/A

Change summary

.github/workflows/danger.yml |  2 +-
.github/workflows/docs.yml   | 24 ++++++++++++++++++++++++
docs/.prettierignore         |  2 ++
docs/theme/fonts/fonts.css   | 16 ++++++++--------
4 files changed, 35 insertions(+), 9 deletions(-)

Detailed changes

.github/workflows/danger.yml

@@ -16,7 +16,7 @@ jobs:
     steps:
       - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
 
-      - uses: pnpm/action-setup@v3
+      - uses: pnpm/action-setup@a3252b78c470c02df07e9d59298aecedc3ccdd6d # v3
         with:
           version: 9
 

.github/workflows/docs.yml

@@ -0,0 +1,24 @@
+name: Docs
+
+on:
+  pull_request:
+    paths:
+      - "docs/**"
+  push:
+    branches:
+      - main
+
+jobs:
+  check_formatting:
+    name: "Check formatting"
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
+
+      - uses: pnpm/action-setup@a3252b78c470c02df07e9d59298aecedc3ccdd6d # v3
+        with:
+          version: 9
+
+      - run: pnpm dlx prettier . --check
+        working-directory: ./docs

docs/.prettierignore

@@ -0,0 +1,2 @@
+# Handlebars partials are not supported by Prettier.
+*.hbs

docs/theme/fonts/fonts.css

@@ -3,15 +3,15 @@
 
 /* open-sans-300 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
 @font-face {
-    font-family: "Agrandir";
-    font-style: normal;
-    font-weight: 400;
-    src: url("PPAgrandir-Regular.woff2") format("woff2");
+  font-family: "Agrandir";
+  font-style: normal;
+  font-weight: 400;
+  src: url("PPAgrandir-Regular.woff2") format("woff2");
 }
 
 @font-face {
-    font-family: "IA Writer Quattro S";
-    font-style: normal;
-    font-weight: 400;
-    src: url("iAWriterQuattroS-Regular.woff2") format("woff2");
+  font-family: "IA Writer Quattro S";
+  font-style: normal;
+  font-weight: 400;
+  src: url("iAWriterQuattroS-Regular.woff2") format("woff2");
 }