beautify overview page & image (#1529) #349
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: Publish Documentation | |
on: | |
push: | |
branches: | |
- main | |
workflow_dispatch: | |
jobs: | |
build_rustdoc: | |
name: Build rustdoc docs | |
runs-on: | |
- self-hosted | |
- v3 | |
container: | |
image: ghcr.io/hulks/hulk-ci:1.81.0 | |
options: --user=1000:1000 | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Build docs | |
run: cargo doc --no-deps --workspace --document-private-items | |
- name: Upload artifact | |
uses: actions/upload-artifact@v4 | |
with: | |
name: rustdoc | |
path: target/doc | |
build_mkdocs: | |
name: Build mkdocs | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
lfs: true | |
- name: Install mkdocs | |
run: pip install mkdocs-material | |
- name: Build docs | |
run: mkdocs build --strict | |
- name: Upload artifact | |
uses: actions/upload-artifact@v4 | |
with: | |
name: mkdocs | |
path: site | |
deploy: | |
name: Deploy to GitHub Pages | |
needs: [build_rustdoc, build_mkdocs] | |
if: github.repository_owner == 'HULKs' | |
permissions: | |
pages: write | |
id-token: write | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: | |
- self-hosted | |
- v3 | |
container: | |
image: ghcr.io/hulks/hulk-ci:1.81.0 | |
options: --user=1000:1000 | |
steps: | |
- name: Download mkdocs artifact | |
uses: actions/download-artifact@v4 | |
with: | |
name: mkdocs | |
path: ${{ runner.temp }}/page | |
- name: Download rustdoc artifact | |
uses: actions/download-artifact@v4 | |
with: | |
name: rustdoc | |
path: ${{ runner.temp }}/page/docs | |
- name: Upload pages artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: ${{ runner.temp }}/page | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |