mirror of
https://github.com/mlua-rs/mlua
synced 2026-06-08 16:05:43 +00:00
69 lines
1.7 KiB
YAML
69 lines
1.7 KiB
YAML
name: Documentation (dev)
|
|
|
|
on:
|
|
push:
|
|
branches: [dev]
|
|
workflow_dispatch:
|
|
|
|
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
|
|
permissions:
|
|
contents: read
|
|
pages: write
|
|
id-token: write
|
|
|
|
# Allow only one concurrent deployment
|
|
concurrency:
|
|
group: pages
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
build:
|
|
name: Build Documentation
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@main
|
|
- uses: dtolnay/rust-toolchain@nightly
|
|
- uses: Swatinem/rust-cache@v2
|
|
|
|
- name: Build documentation
|
|
env:
|
|
RUSTDOCFLAGS: "--cfg docsrs"
|
|
run: |
|
|
cargo +nightly doc --no-deps \
|
|
--features "lua55,vendored,async,send,serde,macros,anyhow,userdata-wrappers"
|
|
|
|
- name: Create index redirect
|
|
run: |
|
|
echo '<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Redirecting to mlua documentation</title>
|
|
<meta http-equiv="refresh" content="0; URL=mlua/index.html">
|
|
<link rel="canonical" href="mlua/index.html">
|
|
</head>
|
|
<body>
|
|
<p>Redirecting to <a href="mlua/index.html">mlua documentation</a>...</p>
|
|
</body>
|
|
</html>' > target/doc/index.html
|
|
|
|
- name: Setup Pages
|
|
uses: actions/configure-pages@v5
|
|
|
|
- name: Upload artifact
|
|
uses: actions/upload-pages-artifact@v4
|
|
with:
|
|
path: target/doc
|
|
|
|
deploy:
|
|
name: Deploy to GitHub Pages
|
|
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
|