mirror of
https://github.com/rust-lang/rust.git
synced 2026-04-27 18:57:42 +03:00
Wilfred Hughes
b198955c90
We want to complain on PRs that generate rustdoc warnings, but only deploy the generate HTML on the master branch. Also fix the existing rustdoc warning. AI disclosure: Some Claude Opus usage.
40 lines
1.0 KiB
YAML
40 lines
1.0 KiB
YAML
name: rustdoc
|
|
on:
|
|
push:
|
|
branches:
|
|
- master
|
|
pull_request:
|
|
merge_group:
|
|
|
|
env:
|
|
CARGO_INCREMENTAL: 0
|
|
CARGO_NET_RETRY: 10
|
|
RUSTFLAGS: "-D warnings -W unreachable-pub"
|
|
RUSTDOCFLAGS: "-D warnings"
|
|
RUSTUP_MAX_RETRIES: 10
|
|
ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION: true
|
|
|
|
jobs:
|
|
rustdoc:
|
|
if: github.repository == 'rust-lang/rust-analyzer'
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v6
|
|
|
|
- name: Install Rust toolchain
|
|
run: rustup update --no-self-update stable
|
|
|
|
- name: Build Documentation
|
|
run: cargo doc --all --no-deps --document-private-items
|
|
|
|
- name: Deploy Docs
|
|
if: github.event_name == 'push' && github.repository == 'rust-lang/rust-analyzer' && github.ref == 'refs/heads/master'
|
|
uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
|
|
with:
|
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
publish_branch: gh-pages
|
|
publish_dir: ./target/doc
|
|
force_orphan: true
|