Merge pull request #8987 from kewisch/deploy-docs-fix

Fix deploy-docs job

Author: kewisch

.github/workflows/deploy-docs.yml

@@ -1,3 +1,4 @@
+---
 name: Deploy docs
 
 on:
@@ -22,18 +23,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-
-      - uses: actions/cache@d4323d4df104b026a6aa633fdb11d772146be0bf # v4.2.2
-        with:
-          path: |
-            ~/.cargo/.crates.toml
-            ~/.cargo/.crates2.toml
-            ~/.cargo/bin/
-            ~/.cargo/registry/index/
-            ~/.cargo/registry/cache/
-            ~/.cargo/git/db/
-          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
+
+      - name: Cargo cache
+        uses: actions-rust-lang/setup-rust-toolchain@9399c7bb15d4c7d47b27263d024f0a4978346ba4  # v1.11.0
 
       - name: Install mdbook and extensions
         run: ./docs/install.sh

.github/workflows/markdown.yml

@@ -13,7 +13,14 @@ jobs:
   markdown_quality:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Cargo cache
+        uses: actions-rust-lang/setup-rust-toolchain@9399c7bb15d4c7d47b27263d024f0a4978346ba4  # v1.11.0
+
+      - name: Install mdbook and extensions
+        run: ./docs/install.sh
 
       - name: Copy CI gradle.properties
         run: mkdir -p ~/.gradle ; cp .github/ci-gradle.properties ~/.gradle/gradle.properties
@@ -28,3 +35,6 @@ jobs:
 
       - name: Quality - Spotless Markdown Check
         run: ./gradlew spotlessMarkdownCheck
+
+      - name: Test mdbook docs
+        run: mdbook test docs

docs/ci/AUTOMATION.md

@@ -24,7 +24,7 @@ You will need the following files:
 - The signing keys with their default filenames
 - A matrix-account.json with the following keys:
 
-```
+```json
 {
   "homeserver": "matrix-client.matrix.org",
   "room": "room id here",
@@ -33,7 +33,6 @@ You will need the following files:
     "github_username": "@matrix_id:mozilla.org"
   }
 }
-
 ```
 
 - `play-store-account.json` with the service account json that will do the uploads
@@ -74,10 +73,12 @@ The environments are locked to the respective branch they belong to.
 
 These environments contain the secrets for signing. Their names follow this pattern:
 
-    <appName>_<releaseType>_<packageFlavor>
-    thunderbird_beta_full
-    thunderbird_beta_foss
-    k9mail_beta_foss
+```text
+<appName>_<releaseType>_<packageFlavor>
+thunderbird_beta_full
+thunderbird_beta_foss
+k9mail_beta_foss
+```
 
 The following secrets are needed: