Skip to content

Commit

Permalink
docs checker job
Browse files Browse the repository at this point in the history
  • Loading branch information
cam-schultz committed Oct 31, 2023
1 parent 9811ffa commit 439b8da
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions .github/workflows/docs_checker.yml
Original file line number Diff line number Diff line change
@@ -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/

0 comments on commit 439b8da

Please sign in to comment.