docs(changelog): fix typos

[woshilapin]

fixes #310

Description

Fix the typos in the changelog and automate typos correction in the changelog generation.

Motivation and Context

#310

How Has This Been Tested?

On my machine at the moment. I expect the next release to reveal if it breaks or not. Note that release.sh will now depend on typos being installed on the machine. Not sure if I should document that somewhere.

Types of Changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation (no code change)
• Refactor (refactoring production code)
• Other

Checklist:

• My code follows the code style of this project.
• I have updated the documentation accordingly.
• I have formatted the code with rustfmt.
• I checked the lints with clippy.
• I have added tests to cover my changes.
• All new and existing tests passed.

[welcome]

Thanks for opening this pull request! Please check out our contributing guidelines! ⛰️

[codecov-commenter]

Codecov Report

All modified lines are covered by tests ✅

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

📢 Thoughts on this report? Let us know!.

[orhun]

Can you maybe update the release script to check if typos is installed? Something like this:

if ! command -v typos &>/dev/null; then
  echo "typos is not installed. Run 'cargo install typos' to install it otherwise the typos won't be checked"
fi

Also, one other thing to note, the CD workflows (cd.yml) use the same git-cliff config so it should also install typos for generating the correct changelog.

[woshilapin]

Can you maybe update the release script to check if typos is installed? Something like this:

if ! command -v typos &>/dev/null; then
  echo "typos is not installed. Run 'cargo install typos' to install it otherwise the typos won't be checked"
fi

Also, one other thing to note, the CD workflows (cd.yml) use the same git-cliff config so it should also install typos for generating the correct changelog.

@orhun I added both in f1983ec.

⚠️ Note however that using the Github Actions will install typos AND check the repository for spelling. Before doing the next release, we should fix all spelling errors. An alternative would be to manually install typos (curl on the released binary), but that would mean giving the version number in the download URL: this means more maintenance burden since each new version of typos would need an update of cd.yml (and typos has really frequent releases, about one per week I'd say).

[orhun]

Got it, I think that's fine. Let's see how it goes.

[welcome]

Congrats on merging your first pull request! ⛰️

[orhun]

Oops, I think we need to install typos via cargo install instead of using the typos action in cd.yml:

 sh: 1: typos: not found
 TRACE git_cliff_core::changelog > 51f5e5b - IO error: `command exited with ExitStatus(unix_wait_status(32512))` (chore(img): add git-cliff logo)
thread '<unnamed>' panicked at git-cliff-core/src/command.rs:44:18:
Failed to write to stdin: Os { code: 32, kind: BrokenPipe, message: "Broken pipe" }

Logs: https://github.com/orhun/git-cliff/actions/runs/6683630522/job/18160024949