Skip to content

Commit

Permalink
ci: deploy documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
guidanoli committed Feb 5, 2024
1 parent 0e8d1ac commit 73d9b54
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Deploy documentation to GitHub Pages

on:
push:
branches: ["main"]

permissions:
contents: read
pages: write
id-token: write

jobs:
deploy:
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- uses: actions/checkout@v4
with:
submodules: recursive

- uses: actions/setup-node@v4
with:
node-version: 18

- uses: foundry-rs/foundry-toolchain@v1

- name: Install dependencies
run: yarn install

- name: Generate documentation
run: forge doc -b

- uses: actions/configure-pages@v4

- uses: actions/upload-pages-artifact@v3
with:
path: docs/book

- id: deployment
uses: actions/deploy-pages@v4

0 comments on commit 73d9b54

Please sign in to comment.