rust/.github/workflows/rustdoc.yaml

name: rustdoc
on:
  push:
   branches:
   - master

env:
  CARGO_INCREMENTAL: 0
  CARGO_NET_RETRY: 10
  RUSTFLAGS: "-D warnings -W unreachable-pub"
  RUSTUP_MAX_RETRIES: 10

jobs:
  rustdoc:
    if: github.repository == 'rust-lang/rust-analyzer'
    runs-on: ubuntu-latest

    steps:
    - name: Checkout repository
      uses: actions/checkout@v3

    - name: Install Rust toolchain
      run: rustup update stable

    - name: Build Documentation
      run: cargo doc --all --no-deps

    - name: Deploy Docs
      uses: peaceiris/actions-gh-pages@364c31d33bb99327c77b3a5438a83a357a6729ad # v3.4.0
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_branch: gh-pages
        publish_dir: ./target/doc
        force_orphan: true
Switch to Actions 2019-11-18 02:13:31 -06:00			`name: rustdoc`
			`on:`
			`push:`
			`branches:`
Deindent YAML 2020-03-04 10:01:38 -06:00			`- master`
Switch to Actions 2019-11-18 02:13:31 -06:00
Specify env once for all jobs 2020-03-26 04:21:00 -05:00			`env:`
			`CARGO_INCREMENTAL: 0`
			`CARGO_NET_RETRY: 10`
Remove more unreachable pubs 2020-11-02 09:31:38 -06:00			`RUSTFLAGS: "-D warnings -W unreachable-pub"`
Specify env once for all jobs 2020-03-26 04:21:00 -05:00			`RUSTUP_MAX_RETRIES: 10`

Switch to Actions 2019-11-18 02:13:31 -06:00			`jobs:`
			`rustdoc:`
minor: Don't run CI on master branch 2022-04-13 17:42:51 -05:00			`if: github.repository == 'rust-lang/rust-analyzer'`
Switch to Actions 2019-11-18 02:13:31 -06:00			`runs-on: ubuntu-latest`

			`steps:`
Deindent YAML 2020-03-04 10:01:38 -06:00			`- name: Checkout repository`
Update GitHub Actions actions/checkout@v2 to v3 The v2 implementation uses Node 12, which is end-of-life on April 30, 2022. See https://nodejs.org/en/about/releases/. Update to v3, which is based on Node 16 whose support lasts until April 30, 2024. 2022-04-30 15:56:03 -05:00			`uses: actions/checkout@v3`
Switch to Actions 2019-11-18 02:13:31 -06:00
Deindent YAML 2020-03-04 10:01:38 -06:00			`- name: Install Rust toolchain`
Remove deprecate action https://old.reddit.com/r/rust/comments/vyx4oj/actionsrs_organization_became_unmaintained/ Looking at this holistically, I don't fully understand why we need an action here? Seems like we can just use rustup? nowadays github runners come with rustup pre-installed. 2022-07-14 14:24:38 -05:00			`run: rustup update stable`
Switch to Actions 2019-11-18 02:13:31 -06:00
Deindent YAML 2020-03-04 10:01:38 -06:00			`- name: Build Documentation`
Remove needless dep 2020-03-04 11:05:29 -06:00			`run: cargo doc --all --no-deps`
Switch to Actions 2019-11-18 02:13:31 -06:00
Deindent YAML 2020-03-04 10:01:38 -06:00			`- name: Deploy Docs`
Fix yaml syntax 2020-03-04 11:55:23 -06:00			`uses: peaceiris/actions-gh-pages@364c31d33bb99327c77b3a5438a83a357a6729ad # v3.4.0`
			`with:`
Update rustdoc action 2020-03-04 11:08:47 -06:00			`github_token: ${{ secrets.GITHUB_TOKEN }}`
			`publish_branch: gh-pages`
Fix rustdoc some more 2020-03-04 11:58:33 -06:00			`publish_dir: ./target/doc`
Update rustdoc action 2020-03-04 11:08:47 -06:00			`force_orphan: true`