ci: add readme check in github code_check action

gwen-lg · Jul 12, 2024 · b29e2b3 · b29e2b3
1 parent 6b82500
commit b29e2b3
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/.github/workflows/code_check.yml b/.github/workflows/code_check.yml
@@ -38,6 +38,14 @@ jobs:
       - name: "Checkout"
         uses: actions/checkout@v4
 
+      - name: Install cargo-readme
+        run: cargo install cargo-readme
+
+      - name: Check if readme is up to date
+        id: cargo_readme
+        if: $${{ always() }}
+        run: diff README.md <(cargo readme)
+
       - name: "Cargo clippy"
         id: cargo_clippy
         if: $${{ always() }}
@@ -71,6 +79,7 @@ jobs:
           echo "" >> $GITHUB_STEP_SUMMARY
           echo "|Job|Status|" >> $GITHUB_STEP_SUMMARY
           echo "|---|------|" >> $GITHUB_STEP_SUMMARY
+          echo "|Cargo readme|${{ steps.cargo_readme.outcome }}|" >> $GITHUB_STEP_SUMMARY
           echo "|Cargo clippy|${{ steps.cargo_clippy.outcome }}|" >> $GITHUB_STEP_SUMMARY
           echo "|Cargo test|${{ steps.cargo_test.outcome }}|" >> $GITHUB_STEP_SUMMARY
           echo "|Cargo fmt|${{ steps.cargo_fmt.outcome }}|" >> $GITHUB_STEP_SUMMARY