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

Setup Typos in CI #140

Merged
merged 2 commits into from
Oct 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -122,3 +122,21 @@ jobs:

- name: Build documentation
run: cargo doc --workspace --all-features --document-private-items --no-deps

typos:
name: Check for typos
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Check for typos
id: typos
uses: crate-ci/typos@v1.26.0

- name: Print help on failure
if: ${{ failure() && steps.typos.conclusion == 'failure' }}
run: |
echo 'To fix typos, please run `typos -w`.'
echo 'To check for a diff, run `typos`.'
echo 'You can install `typos` at <https://crates.io/crates/typos>.'
4 changes: 2 additions & 2 deletions src/external_cli/cargo/metadata.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ pub(crate) fn command() -> Command {
command
}

/// Try to obtain the Cargo metadata of this pacakge.
/// Try to obtain the Cargo metadata of this package.
pub(crate) fn metadata() -> anyhow::Result<Metadata> {
metadata_with_args::<[&str; 0], &str>([])
}

/// Try to obtain the Cargo metadata of this pacakge.
/// Try to obtain the Cargo metadata of this package.
///
/// To see which additional args are available, [consult the `cargo metadata` documentation](https://doc.rust-lang.org/cargo/commands/cargo-metadata.html)
/// or use `cargo metadata --help`.
Expand Down
Loading