From 439b8dabfa81aea905e8b9f8020a157c873c8710 Mon Sep 17 00:00:00 2001 From: cam-schultz Date: Tue, 31 Oct 2023 19:43:52 +0000 Subject: [PATCH] docs checker job --- .github/workflows/docs_checker.yml | 39 ++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 .github/workflows/docs_checker.yml diff --git a/.github/workflows/docs_checker.yml b/.github/workflows/docs_checker.yml new file mode 100644 index 000000000..6f211cdc6 --- /dev/null +++ b/.github/workflows/docs_checker.yml @@ -0,0 +1,39 @@ +name: Forge docs checker + +on: + push: + branches: + - main + pull_request: + branches: + - "*" + +env: + GO_VERSION: "1.20.8" + +jobs: + docs_checker: + name: docs_checker + runs-on: ubuntu-20.04 + + steps: + - name: Checkout Teleporter repository + uses: actions/checkout@v4 + with: + submodules: recursive + + - name: Install Foundry + uses: foundry-rs/foundry-toolchain@v1 + with: + version: nightly + + - name: Generate forge docs + run: | + cd contracts + forge docs --build + + - name: Print diff + run: git --no-pager diff -- contracts/docs/ + + - name: Fail if diff exists + run: git --no-pager diff --quiet -- contracts/docs/ \ No newline at end of file