0fbefe9389
Instead of failing on advisories, run the cargo-deny check, and report the failure. Uses the cargo-deny-action instead of installing this manually. https://github.com/EmbarkStudios/cargo-deny-action/tree/v2?tab=readme-ov-file#recommended-pipeline-if-using-advisories-to-avoid-sudden-breakages (bumped to use rust stable, and log level info)
296 lines
11 KiB
YAML
296 lines
11 KiB
YAML
name: Continuous Integration
|
|
|
|
# Set the permissions of the github token to the minimum and only enable what is needed
|
|
# See https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions
|
|
permissions: {}
|
|
|
|
on:
|
|
# Allows you to run this workflow manually from the Actions tab
|
|
workflow_dispatch:
|
|
push:
|
|
branches:
|
|
- main
|
|
pull_request:
|
|
branches:
|
|
- main
|
|
|
|
# ensure that the workflow is only triggered once per PR, subsequent pushes to the PR will cancel
|
|
# and restart the workflow. See https://docs.github.com/en/actions/using-jobs/using-concurrency
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
|
|
cancel-in-progress: true
|
|
|
|
# lint, clippy and coverage jobs are intentionally early in the workflow to catch simple formatting,
|
|
# typos, and missing tests as early as possible. This allows us to fix these and resubmit the PR
|
|
# without having to wait for the comprehensive matrix of tests to complete.
|
|
jobs:
|
|
# Lint the formatting of the codebase.
|
|
lint-formatting:
|
|
name: Check Formatting
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
|
|
with:
|
|
persist-credentials: false
|
|
- uses: dtolnay/rust-toolchain@0b1efabc08b657293548b77fb76cc02d26091c7e # master
|
|
with:
|
|
toolchain: nightly
|
|
components: rustfmt
|
|
- uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2
|
|
- uses: taiki-e/install-action@763e3324d4fd026c9bd284c504378585777a87d5 # v2
|
|
with:
|
|
tool: taplo-cli
|
|
- run: cargo xtask format --check
|
|
|
|
# Check for typos in the codebase.
|
|
# See <https://github.com/crate-ci/typos/>
|
|
lint-typos:
|
|
name: Check Typos
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
|
|
with:
|
|
persist-credentials: false
|
|
- uses: crate-ci/typos@626c4bedb751ce0b7f03262ca97ddda9a076ae1c # master
|
|
|
|
# Check for any disallowed dependencies in the codebase due to license / security issues.
|
|
# See <https://github.com/EmbarkStudios/cargo-deny>
|
|
cargo-deny:
|
|
runs-on: ubuntu-latest
|
|
strategy:
|
|
matrix:
|
|
checks:
|
|
- advisories
|
|
- bans licenses sources
|
|
# Prevent sudden announcement of a new advisory from failing ci:
|
|
continue-on-error: ${{ matrix.checks == 'advisories' }}
|
|
steps:
|
|
- uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
|
|
with:
|
|
persist-credentials: false
|
|
- uses: EmbarkStudios/cargo-deny-action@76cd80eb775d7bbbd2d80292136d74d39e1b4918 # v2
|
|
with:
|
|
rust-toolchain: stable
|
|
log-level: info
|
|
arguments: --all-features --exclude-unpublished
|
|
command: check ${{ matrix.checks }}
|
|
|
|
# Check for any unused dependencies in the codebase.
|
|
# See <https://github.com/bnjbvr/cargo-machete/>
|
|
cargo-machete:
|
|
name: Check Unused Dependencies
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
|
|
with:
|
|
persist-credentials: false
|
|
- uses: bnjbvr/cargo-machete@7959c845782fed02ee69303126d4a12d64f1db18 # v0.9.1
|
|
|
|
# Run cargo clippy.
|
|
#
|
|
# We check for clippy warnings on beta, but these are not hard failures. They should often be
|
|
# fixed to prevent clippy failing on the next stable release, but don't block PRs on them unless
|
|
# they are introduced by the PR.
|
|
lint-clippy:
|
|
name: Check Clippy
|
|
runs-on: ubuntu-latest
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
toolchain: ["stable", "beta"]
|
|
continue-on-error: ${{ matrix.toolchain == 'beta' }}
|
|
steps:
|
|
- uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
|
|
with:
|
|
persist-credentials: false
|
|
- uses: dtolnay/rust-toolchain@0b1efabc08b657293548b77fb76cc02d26091c7e # master
|
|
with:
|
|
toolchain: ${{ matrix.toolchain }}
|
|
components: clippy
|
|
- uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2
|
|
- run: cargo xtask clippy
|
|
env:
|
|
RUSTUP_TOOLCHAIN: ${{ matrix.toolchain }}
|
|
|
|
# Run markdownlint on all markdown files in the repository.
|
|
lint-markdown:
|
|
name: Check Markdown
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
|
|
with:
|
|
persist-credentials: false
|
|
- uses: DavidAnson/markdownlint-cli2-action@30a0e04f1870d58f8d717450cc6134995f993c63 # v21
|
|
with:
|
|
globs: |
|
|
'**/*.md'
|
|
'!target'
|
|
|
|
# Run cargo coverage. This will generate a coverage report and upload it to codecov.
|
|
# <https://app.codecov.io/gh/ratatui/ratatui>
|
|
coverage:
|
|
name: Coverage Report
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
|
|
with:
|
|
persist-credentials: false
|
|
- uses: dtolnay/rust-toolchain@0b1efabc08b657293548b77fb76cc02d26091c7e # master
|
|
with:
|
|
toolchain: stable
|
|
components: llvm-tools
|
|
- uses: taiki-e/install-action@763e3324d4fd026c9bd284c504378585777a87d5 # v2
|
|
with:
|
|
tool: cargo-llvm-cov
|
|
- uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2
|
|
- run: cargo xtask coverage
|
|
- uses: codecov/codecov-action@5a1091511ad55cbe89839c7260b706298ca349f7 # v5
|
|
with:
|
|
token: ${{ secrets.CODECOV_TOKEN }}
|
|
fail_ci_if_error: true
|
|
|
|
# Run cargo check. This is a fast way to catch any obvious errors in the code.
|
|
check:
|
|
name: Check ${{ matrix.os }} ${{ matrix.toolchain }}
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
os: [ubuntu-latest, windows-latest, macos-latest]
|
|
toolchain: ["1.85.0", "stable"]
|
|
runs-on: ${{ matrix.os }}
|
|
steps:
|
|
- uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
|
|
with:
|
|
persist-credentials: false
|
|
- uses: dtolnay/rust-toolchain@0b1efabc08b657293548b77fb76cc02d26091c7e # master
|
|
with:
|
|
toolchain: ${{ matrix.toolchain }}
|
|
- uses: taiki-e/install-action@763e3324d4fd026c9bd284c504378585777a87d5 # v2
|
|
with:
|
|
tool: cargo-hack
|
|
- uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2
|
|
- run: cargo xtask check --all-features
|
|
env:
|
|
RUSTUP_TOOLCHAIN: ${{ matrix.toolchain }}
|
|
|
|
build-no-std:
|
|
name: Build No-Std
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
|
|
with:
|
|
persist-credentials: false
|
|
- uses: dtolnay/rust-toolchain@0b1efabc08b657293548b77fb76cc02d26091c7e # master
|
|
with:
|
|
toolchain: stable
|
|
targets: x86_64-unknown-none
|
|
- uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2
|
|
# This makes it easier to debug the exact versions of the dependencies
|
|
- run: cargo tree --target x86_64-unknown-none -p ratatui-core
|
|
- run: cargo tree --target x86_64-unknown-none -p ratatui-widgets
|
|
- run: cargo tree --target x86_64-unknown-none -p ratatui-macros
|
|
- run: cargo tree --target x86_64-unknown-none -p ratatui --no-default-features
|
|
- run: cargo build --target x86_64-unknown-none -p ratatui-core
|
|
- run: cargo build --target x86_64-unknown-none -p ratatui-widgets
|
|
- run: cargo build --target x86_64-unknown-none -p ratatui-macros
|
|
- run: cargo build --target x86_64-unknown-none -p ratatui --no-default-features
|
|
|
|
# Check if README.md is up-to-date with the crate's documentation.
|
|
check-readme:
|
|
name: Check README
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
|
|
with:
|
|
persist-credentials: false
|
|
- uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2
|
|
- uses: taiki-e/install-action@763e3324d4fd026c9bd284c504378585777a87d5 # v2
|
|
with:
|
|
tool: cargo-rdme
|
|
- run: cargo xtask readme --check
|
|
|
|
# Run cargo rustdoc with the same options that would be used by docs.rs, taking into account the
|
|
# package.metadata.docs.rs configured in Cargo.toml. https://github.com/dtolnay/cargo-docs-rs
|
|
lint-docs:
|
|
name: Check Docs
|
|
runs-on: ubuntu-latest
|
|
env:
|
|
RUSTDOCFLAGS: -Dwarnings
|
|
steps:
|
|
- uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
|
|
with:
|
|
persist-credentials: false
|
|
- uses: dtolnay/rust-toolchain@0b1efabc08b657293548b77fb76cc02d26091c7e # master
|
|
with:
|
|
toolchain: nightly
|
|
- uses: dtolnay/install@74f735cdf643820234e37ae1c4089a08fd266d8a # master
|
|
with:
|
|
crate: cargo-docs-rs
|
|
- uses: taiki-e/install-action@763e3324d4fd026c9bd284c504378585777a87d5 # v2
|
|
with:
|
|
tool: cargo-hack
|
|
- uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2
|
|
- run: cargo xtask docs
|
|
|
|
# Run cargo test on the documentation of the crate. This will catch any code examples that don't
|
|
# compile, or any other issues in the documentation.
|
|
test-docs:
|
|
name: Test Docs
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
|
|
with:
|
|
persist-credentials: false
|
|
- uses: dtolnay/rust-toolchain@0b1efabc08b657293548b77fb76cc02d26091c7e # master
|
|
with:
|
|
toolchain: stable
|
|
- uses: taiki-e/install-action@763e3324d4fd026c9bd284c504378585777a87d5 # v2
|
|
with:
|
|
tool: cargo-hack
|
|
- uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2
|
|
- run: cargo xtask test-docs
|
|
|
|
# Run cargo test on the libraries of the crate.
|
|
test-libs:
|
|
name: Test Libs ${{ matrix.toolchain }}
|
|
runs-on: ubuntu-latest
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
toolchain: ["1.85.0", "stable"]
|
|
steps:
|
|
- uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
|
|
with:
|
|
persist-credentials: false
|
|
- uses: dtolnay/rust-toolchain@0b1efabc08b657293548b77fb76cc02d26091c7e # master
|
|
with:
|
|
toolchain: stable
|
|
- uses: taiki-e/install-action@763e3324d4fd026c9bd284c504378585777a87d5 # v2
|
|
with:
|
|
tool: cargo-hack
|
|
- uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2
|
|
- run: cargo xtask test-libs
|
|
|
|
# Run cargo test on all the backends.
|
|
test-backends:
|
|
name: Test ${{matrix.backend}} on ${{ matrix.os }}
|
|
runs-on: ${{ matrix.os }}
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
os: [ubuntu-latest, windows-latest, macos-latest]
|
|
backend: [crossterm, termion, termwiz]
|
|
exclude:
|
|
# termion is not supported on windows
|
|
- os: windows-latest
|
|
backend: termion
|
|
steps:
|
|
- uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
|
|
with:
|
|
persist-credentials: false
|
|
- uses: dtolnay/rust-toolchain@0b1efabc08b657293548b77fb76cc02d26091c7e # master
|
|
with:
|
|
toolchain: stable
|
|
- uses: Swatinem/rust-cache@f13886b937689c021905a6b90929199931d60db1 # v2
|
|
- run: cargo xtask test-backend ${{ matrix.backend }}
|