-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
112db22
commit 717f0c1
Showing
1 changed file
with
33 additions
and
29 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,41 +1,45 @@ | ||
name: Publish Documentation | ||
|
||
on: | ||
# Trigger the workflow on pushes to the main branch | ||
push: | ||
branches: | ||
- main | ||
branches: [main] | ||
|
||
# Allows you to manually trigger the workflow from GitHub | ||
workflow_dispatch: | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
# Checkout the repository code | ||
- name: Checkout code | ||
uses: actions/checkout@v3 | ||
|
||
# Install Rust (default target is fine here) | ||
- name: Install Rust | ||
uses: actions-rs/toolchain@v1 | ||
with: | ||
toolchain: stable | ||
profile: minimal | ||
override: true | ||
|
||
# Build the documentation | ||
- name: Build documentation | ||
run: cargo doc --no-deps | ||
|
||
# Deploy to gh-pages branch | ||
- name: Deploy to GitHub Pages | ||
uses: peaceiris/actions-gh-pages@v3 | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_dir: ./target/doc | ||
destination_dir: ./datamaxi | ||
publish_branch: gh-pages | ||
allow_empty_commit: true | ||
- 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 --no-deps | ||
|
||
- name: Add redirect | ||
run: echo '<meta http-equiv="refresh" content="0;url=datamaxi/index.html">' > target/doc/index.html | ||
|
||
- name: Remove lock file | ||
run: rm target/doc/.lock | ||
|
||
- name: Deploy to GitHub Pages | ||
uses: peaceiris/actions-gh-pages@v3 | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_dir: ./target/doc | ||
publish_branch: gh-pages | ||
allow_empty_commit: true |