Skip to content

chore(release): v0.4.2 #52

chore(release): v0.4.2

chore(release): v0.4.2 #52

Workflow file for this run

name: Docs
# Publish rustdoc to GitHub Pages on every push to `main` and on
# every `v*` tag. The site lives at:
# https://rustakka.github.io/atomr-accel/atomr_accel/index.html
#
# Mirrors the atomr workspace's docs.yml. atomr uses mkdocs-material
# because its docs are markdown-driven; atomr-accel's primary doc
# surface is rustdoc, so we publish that instead. The markdown docs
# under `docs/` are linked from rustdoc and the README.
on:
push:
branches: [main]
tags: ["v*"]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: docs-${{ github.ref }}
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout sibling atomr
uses: actions/checkout@v4
with:
repository: rustakka/atomr
path: atomr
- name: Checkout atomr-accel
uses: actions/checkout@v4
with:
path: atomr-accel
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
with: { workspaces: atomr-accel }
- name: cargo doc --workspace --no-deps (every feature on)
working-directory: atomr-accel
run: |
cargo doc --workspace --no-deps \
--features atomr-accel-cuda/full-cuda,atomr-accel-cuda/replay,atomr-accel-cuda/cluster,atomr-accel-cuda/streams,atomr-accel-cuda/telemetry
- name: Add index redirect to the umbrella crate
working-directory: atomr-accel
run: |
cat > target/doc/index.html <<'EOF'
<!doctype html>
<meta charset="utf-8">
<title>atomr-accel — Rust API documentation</title>
<meta http-equiv="refresh" content="0; url=atomr_accel/index.html">
<link rel="canonical" href="atomr_accel/index.html">
EOF
- uses: actions/configure-pages@v5
- uses: actions/upload-pages-artifact@v3
with:
path: atomr-accel/target/doc
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v4