Skip to content

Commit

Permalink
chore: Update .github/workflows/rustdoc.yaml in `artichoke/posix-sp…
Browse files Browse the repository at this point in the history
…ace`

Managed by Terraform.

## Contents

```
---
name: Documentation
"on":
  push:
    branches:
      - trunk
  pull_request:
    branches:
      - trunk
  schedule:
    - cron: "0 0 * * TUE"
concurrency:
  group: docs-${{ github.head_ref }}
jobs:
  rustdoc:
    name: Build Rust API docs
    runs-on: ubuntu-latest
    env:
      RUSTDOCFLAGS: -D warnings -D rustdoc::broken_intra_doc_links --cfg docsrs
      RUST_BACKTRACE: 1

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

      - name: Install Rust toolchain
        uses: artichoke/setup-rust/rustdoc@v1

      - name: Check docs with no default features
        run: cargo doc --workspace --no-default-features

      - name: Clean docs
        run: cargo clean

      - name: Build Documentation
        run: cargo doc --workspace

      - name: Deploy Docs
        uses: peaceiris/actions-gh-pages@v3
        if: github.ref == 'refs/heads/trunk'
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./target/doc
          publish_branch: gh-pages
          user_name: artichoke-ci
          user_email: [email protected]
          # only have the most recent docs in the `gh-pages` branch
          # artichoke/artichoke#1826
          force_orphan: true
```
  • Loading branch information
artichoke-ci committed Nov 6, 2022
1 parent f866de2 commit b739fee
Showing 1 changed file with 2 additions and 22 deletions.
24 changes: 2 additions & 22 deletions .github/workflows/rustdoc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,24 23,8 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v3

- name: Install nightly Rust toolchain
run: |
echo "::group::rustup toolchain install"
rustup toolchain install nightly --profile minimal
echo "::endgroup::"
echo "::group::set default toolchain"
rm -rf rust-toolchain
rustup default nightly
echo "::endgroup::"
echo "::group::rustup version"
rustup -Vv
echo "::endgroup::"
echo "::group::rustc version"
rustc -Vv
echo "::endgroup::"
echo "::group::cargo version"
cargo version --verbose
echo "::endgroup::"
- name: Install Rust toolchain
uses: artichoke/setup-rust/rustdoc@v1

- name: Check docs with no default features
run: cargo doc --workspace --no-default-features
Expand All @@ -51,10 35,6 @@ jobs:
- name: Build Documentation
run: cargo doc --workspace

# https://github.com/artichoke/artichoke/issues/1826
- name: Purge sources from out dir
run: find . -path './target/doc/*/target/debug/build/*' | xargs rm -rf

- name: Deploy Docs
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/trunk'
Expand Down

0 comments on commit b739fee

Please sign in to comment.