Skip to content

Commit

Permalink
Merge pull request #3012 from iosh/docs
Browse files Browse the repository at this point in the history
chore: add build and deploy docs
  • Loading branch information
Pana authored Dec 23, 2024
2 parents de1eb91 + 6c91fa8 commit 48177d5
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 3 deletions.
34 changes: 34 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Deploy Docs

on:
push:
branches:
- master

jobs:
deploy:
permissions:
contents: write

runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Setup Rust
uses: actions-rs/toolchain@v1
with:
# rustc 1.77.0-nightly
# build doc index.html needs nightly
toolchain: nightly-2024-01-29

- name: Build Docs
env:
RUSTDOCFLAGS: "--enable-index-page -Z unstable-options"
run: |
cargo +nightly-2024-01-29 doc --no-deps
- name: Deploy
uses: peaceiris/actions-gh-pages@v3

with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./target/doc
4 changes: 2 additions & 2 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion crates/util/runtime/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
futures01 = { workspace = true }
futures01 = { version = "0.1", package = "futures" }
tokio = "~0.1.9"

0 comments on commit 48177d5

Please sign in to comment.