Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Update .github/workflows/rustdoc.yaml in `artichoke/strftime… #78

Merged

Conversation

lopopolo
Copy link
Member

@lopopolo lopopolo commented Nov 6, 2022

…-ruby`

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
          # https://github.com/artichoke/artichoke/issues/1826
          force_orphan: true

…-ruby`

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
```
@lopopolo lopopolo added A-build Area: CI build infrastructure. A-deps Area: Source and library dependencies. labels Nov 6, 2022
@lopopolo
Copy link
Member Author

lopopolo commented Nov 6, 2022

@x-hgg-x I'll be making some changes to the GitHub Actions config and how it sets up Rust toolchains to address Node.js 12 GHA runtime deprecations because the actions-rs actions appear to be unmaintained. I'll be replacing these with the family of composite actions in https://github.com/artichoke/setup-rust.

@lopopolo
Copy link
Member Author

lopopolo commented Nov 6, 2022

admin merging to bypass clippy lint breakage on latest stable. will fix in a followup.

@lopopolo lopopolo merged commit 74e14e4 into trunk Nov 6, 2022
@lopopolo lopopolo deleted the terraform/update-file-.github-workflows-rustdoc.yaml branch November 6, 2022 00:44
@lopopolo lopopolo restored the terraform/update-file-.github-workflows-rustdoc.yaml branch November 6, 2022 00:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-build Area: CI build infrastructure. A-deps Area: Source and library dependencies.
Development

Successfully merging this pull request may close these issues.

2 participants