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

ci: typo ignore #320

Merged
merged 1 commit into from
Nov 12, 2024
Merged

ci: typo ignore #320

merged 1 commit into from
Nov 12, 2024

Conversation

peter-jerry-ye
Copy link
Collaborator

No description provided.

Copy link

peter-jerry-ye-code-review bot commented Oct 23, 2024

Observations from git diff Output

  1. Typo in Documentation:

    • In the file moonbit-docs/docs/examples/sudoku/index.md, there is a typo in the description of the Sudoku solver. The word "writen" should be corrected to "written".
      -Visit MoonBit [Gallery](https://www.moonbitlang.com/gallery/sudoku/) to play with the Sudoku solver writen in MoonBit. Click [this link](https://github.com/myfreess/sudoku) to view the full source code.
      +Visit MoonBit [Gallery](https://www.moonbitlang.com/gallery/sudoku/) to play with the Sudoku solver written in MoonBit. Click [this link](https://github.com/myfreess/sudoku) to view the full source code.
  2. Workflow File Redundancy:

    • The original .github/workflows/check.yml file contains a section for typo checking which is redundant since a new workflow file .github/workflows/typo.yml is being added. The original typo checking section in check.yml should be removed to avoid duplicative checks.
      -  typo-check:
      -    runs-on: ubuntu-latest
      -    timeout-minutes: 10
      -    env:
      -      FORCE_COLOR: 1
      -      TYPOS_VERSION: v1.19.0
      -    steps:
      -      - name: download typos
      -        run: curl -LsSf https://github.com/crate-ci/typos/releases/download/$TYPOS_VERSION/typos-$TYPOS_VERSION-x86_64-unknown-linux-musl.tar.gz | tar zxf - -C ${CARGO_HOME:-~/.cargo}/bin
      -
      -      - name: Checkout repository
      -        uses: actions/checkout@v4
      -        with:
      -          ref: ${{ github.event.pull_request.head.sha }}
      -
      -      - name: check typos
      -        run: typos
  3. Configuration File for Typos:

    • A new configuration file typos.toml is added to manage typo checking exclusions and ignore words. This is a good practice to ensure that the typo checker does not flag legitimate terms or files that are intentionally named or formatted in a specific way.
      +[files]
      +extend-exclude = ["*.excalidraw"]
      +
      +[default]
      +extend-ignore-words-re = ["CAF", "ND"]

These changes collectively improve the codebase by correcting a typo, ensuring efficient use of GitHub Actions workflows, and providing a clear configuration for typo checking.

@peter-jerry-ye peter-jerry-ye force-pushed the ci-typo branch 4 times, most recently from 52682c0 to dd90753 Compare October 23, 2024 06:24
@bzy-debug bzy-debug merged commit 074aebc into main Nov 12, 2024
2 checks passed
@bzy-debug bzy-debug deleted the ci-typo branch November 12, 2024 06:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants