Skip to content

chore: trigger CI

chore: trigger CI #10

Workflow file for this run

# Build and deploy Rust documentation to GitHub Pages
#
# Docs will be available at: https://one-covenant.github.io/bittensor-rs/bittensor_rs/
name: Documentation
on:
push:
branches: [main]
pull_request:
branches: [main]
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: true
env:
CARGO_TERM_COLOR: always
BITTENSOR_OFFLINE: "1" # Use bundled metadata
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install Rust
uses: dtolnay/rust-toolchain@stable
- name: Install protoc
run: |
sudo apt-get update
sudo apt-get install -y protobuf-compiler
- name: Cache cargo
uses: actions/cache@v4
with:
path: |
~/.cargo/registry
~/.cargo/git
target
key: ${{ runner.os }}-cargo-docs-${{ hashFiles('**/Cargo.lock') }}
restore-keys: |
${{ runner.os }}-cargo-docs-
- name: Build documentation
run: |
cargo doc --no-deps -p bittensor-rs --document-private-items
- name: Add redirect
run: |
echo '<meta http-equiv="refresh" content="0; url=bittensor_rs/index.html">' > target/doc/index.html
- name: Upload artifact
if: github.ref == 'refs/heads/main'
uses: actions/upload-pages-artifact@v3
with:
path: target/doc
deploy:
if: github.ref == 'refs/heads/main'
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4