Skip to content

Update cryptography #12

Update cryptography

Update cryptography #12

Workflow file for this run

name: docs
# Adapted from https://github.com/mitmproxy/pdoc/blob/316554dd40e69a407800dcf08cea622529b37a7c/.github/workflows/docs.yml
# build the documentation whenever there are new commits on the trunk
on:
push:
branches:
- trunk
# TODO: Once cutting stable releases, only build for tags.
# tags:
# - '*'
# 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-file: .github/python-version.txt
- name: Install Poetry
uses: snok/install-poetry@v1
with:
virtualenvs-create: true
virtualenvs-in-project: true
- name: Install library and all its dependencies
run: poetry install --no-interaction
- name: Build documentation of ./chai/ into ./docs/
run: poetry run pdoc -o ./docs/ ./chai/
- name: Upload site artifacts
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