Merge pull request #659 from DefGuard/dev #348
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: rustdoc Github Pages | |
on: | |
push: | |
branches: | |
- main | |
paths-ignore: | |
- "*.md" | |
- "LICENSE" | |
env: | |
CARGO_INCREMENTAL: 0 | |
CARGO_NET_RETRY: 10 | |
CARGO_TERM_COLOR: always | |
RUSTFLAGS: "-D warnings -W unreachable-pub" | |
jobs: | |
rustdoc: | |
runs-on: [self-hosted, Linux] | |
container: rust:1.77 | |
services: | |
postgres: | |
image: postgres:15-alpine | |
env: | |
POSTGRES_DB: defguard | |
POSTGRES_USER: defguard | |
POSTGRES_PASSWORD: defguard | |
options: >- | |
--health-cmd pg_isready | |
--health-interval 10s | |
--health-timeout 5s | |
--health-retries 5 | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
with: | |
submodules: recursive | |
- name: Set database URL | |
run: sed -i -e 's,localhost,postgres,' .env | |
- name: Install protoc | |
run: apt-get update && apt-get -y install protobuf-compiler | |
- name: Build Docs | |
env: | |
DEFGUARD_DB_HOST: postgres | |
DEFGUARD_DB_PORT: 5432 | |
DEFGUARD_DB_NAME: defguard | |
DEFGUARD_DB_USER: defguard | |
DEFGUARD_DB_PASSWORD: defguard | |
SQLX_OFFLINE: true | |
run: cargo doc --all --no-deps | |
- name: Deploy Docs | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_branch: gh-pages | |
publish_dir: ./target/doc | |
force_orphan: true |