mirror of https://github.com/crytic/slither
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
44 lines
1.1 KiB
44 lines
1.1 KiB
2 years ago
|
name: docs
|
||
|
|
|
||
|
|
# build the documentation whenever there are new commits on main
|
||
|
|
on:
|
||
|
|
push:
|
||
|
|
branches:
|
||
|
|
- dev
|
||
|
|
- master
|
||
|
|
|
||
|
|
# security: restrict permissions for CI jobs.
|
||
|
|
permissions:
|
||
|
|
contents: read
|
||
|
|
|
||
|
|
jobs:
|
||
|
|
# Build the documentation and upload the static HTML files as an artifact.
|
||
|
|
build:
|
||
|
|
runs-on: ubuntu-latest
|
||
|
|
steps:
|
||
|
|
- uses: actions/checkout@v3
|
||
|
|
- uses: actions/setup-python@v4
|
||
|
|
with:
|
||
|
|
python-version: '3.8'
|
||
|
|
|
||
|
|
- run: pip install -e ".[dev]"
|
||
|
|
- run: pdoc -o docs/ slither '!slither.tools' #TODO fix import errors on pdoc run
|
||
|
|
|
||
|
|
- uses: actions/upload-pages-artifact@v1
|
||
|
|
with:
|
||
|
|
path: docs/
|
||
|
|
|
||
|
|
# Deploy the artifact to GitHub pages.
|
||
|
|
# This is a separate job so that only actions/deploy-pages has the necessary permissions.
|
||
|
|
deploy:
|
||
|
|
needs: build
|
||
|
|
runs-on: ubuntu-latest
|
||
|
|
permissions:
|
||
|
|
pages: write
|
||
|
|
id-token: write
|
||
|
|
environment:
|
||
|
|
name: github-pages
|
||
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
||
|
|
steps:
|
||
|
|
- id: deployment
|
||
|
|
uses: actions/deploy-pages@v1
|