Integrate typos tool into CI #6967
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| name: 💾 Memoize Functions | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - dev | ||
| paths: | ||
| - 'pkg/js/libs/**' | ||
| - 'cmd/memogen/**' | ||
| workflow_dispatch: {} | ||
|
|
||
| jobs: | ||
| memogen: | ||
| if: ${{ !endsWith(github.actor, '[bot]') }} | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | ||
| - uses: projectdiscovery/actions/setup/go@3bde399a61ae14f8dfe72f4aeffd77571204a0e1 # v1 | ||
| - uses: projectdiscovery/actions/setup/git@e28e4a08cde4e3e97c8f7c2e8b04f6a3c9a74b2d # v1 | ||
| - run: make memogen | ||
| - run: git status -s | wc -l | xargs -I {} echo CHANGES={} >> $GITHUB_OUTPUT | ||
| id: status | ||
| - uses: projectdiscovery/actions/commit@a4b5c6d7e8f9a4b5c6d7e8f9a4b5c6d7e8f9a4b5 # v1 | ||
| if: steps.status.outputs.CHANGES > 0 | ||
| with: | ||
| files: | | ||
| pkg/js/libs/ | ||
| message: 'chore(js): update memoized functions 🤖' | ||
| - run: git push origin ${{ github.ref }} | ||
| if: steps.status.outputs.CHANGES > 0 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # typos configuration | ||
| # See https://github.com/crate-ci/typos/blob/master/docs/reference.md | ||
|
|
||
| [default] | ||
| # extend-words = {} | ||
| # extend-ignore-words-re = [] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| name: Typos Check | ||
|
There was a problem hiding this comment. 🟡 Unpinned pip package version allows supply chain drift — The command 'pip install typos' installs the latest version without pinning to a specific version or hash. This allows automatic updates that could introduce breaking changes or malicious code if the package is compromised. Suggested FixHowever, switching to the official GitHub Action (as recommended above) is the better solution as it uses pinned commit SHAs. Pin typos package version with hash verification or switch to official GitHub Action |
||
|
|
||
| on: | ||
| push: | ||
| branches: [ main ] | ||
| pull_request: | ||
| branches: [ main ] | ||
|
|
||
| jobs: | ||
| typos-check: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | ||
|
|
||
| - name: Check spelling with typos | ||
| uses: crate-ci/typos@b67cb3f3f8b7c0f27568b1e19b8f62f6d8a6b1e4 # v1.28.3 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟡 Suboptimal typos installation method in CI workflow — The workflow installs typos via pip (Python package manager) instead of using the official GitHub Action or pre-built binaries. While the PyPI package is legitimate, this approach is less secure and less efficient than the recommended methods.
Suggested Fix
Alternatively, install the pre-built binary directly:
Replace pip install typos with official crate-ci/typos GitHub Action