From 7c9d5de5354bc745b82751845895691faec11e0b Mon Sep 17 00:00:00 2001 From: trisua Date: Wed, 2 Apr 2025 15:21:15 -0400 Subject: [PATCH] Update and rename rust-clippy.yml to docs.yml --- .github/workflows/docs.yml | 49 +++++++++++++++++++++++++++ .github/workflows/rust-clippy.yml | 55 ------------------------------- 2 files changed, 49 insertions(+), 55 deletions(-) create mode 100644 .github/workflows/docs.yml delete mode 100644 .github/workflows/rust-clippy.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..91b55ab --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,49 @@ +name: Docs +on: + push: + branches: [master] + workflow_dispatch: +permissions: + contents: read + pages: write + id-token: write +concurrency: + group: deploy + cancel-in-progress: false +jobs: + build: + name: Rustdoc + runs-on: ubuntu-latest + steps: + - name: Checkout repo + uses: actions/checkout@v4 + - name: Checkout repo submodules + run: git submodule update --init --recursive + - name: Init Rust + uses: dtolnay/rust-toolchain@stable + - name: Configure cache + uses: Swatinem/rust-cache@v2 + - name: Configure pages + id: pages + uses: actions/configure-pages@v4 + - name: Clean docs directory + run: cargo clean --doc + - name: Build documentation + run: cargo doc --no-deps --document-private-items --workspace + - name: Create index.html + run: echo '' > target/doc/index.html + - name: Artifact + uses: actions/upload-pages-artifact@v3 + with: + path: target/doc + deploy: + name: Pages + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.github/workflows/rust-clippy.yml b/.github/workflows/rust-clippy.yml deleted file mode 100644 index 0ba262a..0000000 --- a/.github/workflows/rust-clippy.yml +++ /dev/null @@ -1,55 +0,0 @@ -# This workflow uses actions that are not certified by GitHub. -# They are provided by a third-party and are governed by -# separate terms of service, privacy policy, and support -# documentation. -# rust-clippy is a tool that runs a bunch of lints to catch common -# mistakes in your Rust code and help improve your Rust code. -# More details at https://github.com/rust-lang/rust-clippy -# and https://rust-lang.github.io/rust-clippy/ - -name: rust-clippy analyze - -on: - push: - branches: [ "master" ] - pull_request: - # The branches below must be a subset of the branches above - branches: [ "master" ] - schedule: - - cron: '23 2 * * 0' - -jobs: - rust-clippy-analyze: - name: Run rust-clippy analyzing - runs-on: ubuntu-latest - permissions: - contents: read - security-events: write - actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status - steps: - - name: Checkout code - uses: actions/checkout@v4 - - - name: Install Rust toolchain - uses: actions-rs/toolchain@16499b5e05bf2e26879000db0c1d13f7e13fa3af #@v1 - with: - profile: minimal - toolchain: stable - components: clippy - override: true - - - name: Install required cargo - run: cargo install clippy-sarif sarif-fmt - - - name: Run rust-clippy - run: - cargo clippy - --all-features - --message-format=json | clippy-sarif | tee rust-clippy-results.sarif | sarif-fmt - continue-on-error: true - - - name: Upload analysis results to GitHub - uses: github/codeql-action/upload-sarif@v3 - with: - sarif_file: rust-clippy-results.sarif - wait-for-processing: true