Skip to content

Commit

Permalink
ci: add docs page deployment workflow
Browse files Browse the repository at this point in the history
Lifted from the equivalent config in the rustls repo, and customized for
rustls-ffi.
  • Loading branch information
cpu committed Dec 20, 2024
1 parent 6ca976a commit 4d46f19
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: documentation

permissions:
contents: read

on:
workflow_dispatch:
push:
branches:
- main
schedule:
- cron: '0 18 * * *'

jobs:
generate:
name: Generate API documentation
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@v4
with:
persist-credentials: false

- name: Install rust toolchain
uses: dtolnay/rust-toolchain@nightly

- name: Install zola
uses: taiki-e/install-action@v2
with:
tool: [email protected] # Matched to rustls repo

- name: Generate API JSON data
run:
cargo run --bin docgen > website/static/api.json

- name: Generate site pages
run: |
cd website && zola build --output-dir ../target/website/
- name: Package and upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./target/website/

deploy:
name: Deploy
runs-on: ubuntu-latest
if: github.repository == 'rustls/rustls-ffi'
needs: generate
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit 4d46f19

Please sign in to comment.