-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9811ffa
commit 439b8da
Showing
1 changed file
with
39 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/ |