fix(docs): broken link in top-level README #34
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Docs | |
on: | |
push: | |
branches: [ main ] | |
workflow_dispatch: | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
concurrency: | |
group: deploy | |
cancel-in-progress: false | |
jobs: | |
build: | |
name: Build | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
- name: Setup Rust | |
uses: dtolnay/rust-toolchain@stable | |
- name: Configure cache | |
uses: Swatinem/rust-cache@v2 | |
- name: Setup pages | |
id: pages | |
uses: actions/configure-pages@v4 | |
- name: Clean docs folder | |
run: cargo clean --doc | |
- name: Build docs | |
run: cargo doc --all-features --no-deps | |
- name: Add redirect | |
run: echo '<meta http-equiv="refresh" content="0;url=falco_plugin/index.html">' > target/doc/index.html | |
- name: Remove lock file | |
run: rm target/doc/.lock | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: target/doc | |
deploy: | |
name: Deploy | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
needs: build | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |