Skip to content

Commit

Permalink
ci: Add spellcheck to CI
Browse files Browse the repository at this point in the history
In order to ensure that typos are not introduced in future commits,
this commit adds a spellchecker to CI.

See also: rust-windowing/winit#3557

Signed-off-by: John Nunley <dev@notgull.net>
  • Loading branch information
notgull committed Mar 13, 2024
1 parent 41f014d commit 83e5785
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
8 changes: 7 additions & 1 deletion .github/workflows/ci.yml
Expand Up @@ -13,19 +13,25 @@ env:

jobs:
fmt:
name: Check Formatting
name: Tidy Code
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: hecrj/setup-rust-action@v1
with:
rust-version: stable
components: rustfmt
- uses: taiki-e/install-action@v2
with:
tool: typos-cli
- name: Check Formatting
run: cargo fmt --all -- --check
- name: Run Typos
run: typos

tests:
name: Tests
needs: fmt
# `raw-window-handle` only has `cfg` guards for Android, so we just run Ubuntu
# and manually test Android
runs-on: ubuntu-latest
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Expand Up @@ -159,7 +159,7 @@ pub enum RawWindowHandle {
///
/// ## Availability Hints
/// This variant is present regardless of windowing backend and likely to be used with
/// EGL_MESA_platfrom_gbm or EGL_KHR_platfrom_gbm.
/// EGL_MESA_platform_gbm or EGL_KHR_platform_gbm.
Gbm(GbmWindowHandle),
/// A raw window handle for Win32.
///
Expand Down

0 comments on commit 83e5785

Please sign in to comment.