Skip to content

docgen/website: show deprecated function warnings on docs website #584

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ permissions:
on:
workflow_dispatch:
push:
branches:
- main
branches: ['main', 'rel-*', 'ci/*']
pull_request:
merge_group:
schedule:
- cron: '0 18 * * *'

Expand All @@ -29,23 +30,29 @@ jobs:
with:
tool: zola@0.19.1 # Matched to rustls repo

- name: Generate API JSON data
run:
cargo run -p rustls-ffi-tools --bin docgen > website/static/api.json
- name: Verify API docs JSON data
run: |
if ! diff website/static/api.json <(cargo run -p rustls-ffi-tools --bin docgen 2>/dev/null); then
echo
echo "ERROR: Generated api.json differs from checked-in version"
echo "Run 'cargo run -p rustls-ffi-tools --bin docgen > website/static/api.json' and commit the changes"
exit 1
fi

- name: Generate site pages
run: |
cd website && zola build --output-dir ../target/website/

- name: Package and upload artifact
uses: actions/upload-pages-artifact@v3
if: github.ref == 'refs/heads/main'
with:
path: ./target/website/

deploy:
name: Deploy
runs-on: ubuntu-latest
if: github.repository == 'rustls/rustls-ffi'
if: github.repository == 'rustls/rustls-ffi' && github.ref == 'refs/heads/main'
needs: generate
permissions:
pages: write
Expand Down
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,4 @@ librustls/cmake-build*
.vs
debian/usr
debian/DEBIAN
/website/static/api.json
/website/public
Loading
Loading