Skip to content

Add code spell check github workflow#573

Merged
hzxuzhonghu merged 5 commits intokmesh-net:mainfrom
Okabe-Rintarou-0:main
Jul 15, 2024
Merged

Add code spell check github workflow#573
hzxuzhonghu merged 5 commits intokmesh-net:mainfrom
Okabe-Rintarou-0:main

Conversation

@Okabe-Rintarou-0
Copy link
Copy Markdown
Member

What type of PR is this?
feature

What this PR does / why we need it:
Current there are many spelling errors in kmesh, we need an automatic way to check spelling errors.

We can config what we don't need to check in .codespellrc.
Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:


Signed-off-by: 923048992@qq.com <923048992@qq.com>
Signed-off-by: 923048992@qq.com <923048992@qq.com>
Signed-off-by: 923048992@qq.com <923048992@qq.com>
Signed-off-by: 923048992@qq.com <923048992@qq.com>
Signed-off-by: 923048992@qq.com <923048992@qq.com>
@Okabe-Rintarou-0
Copy link
Copy Markdown
Member Author

Okabe-Rintarou-0 commented Jul 14, 2024

I also use this action in my repo. The check process is very rapid. It will not affect other CI/CD.

BTW, i have fixed some typo erros, according to the report.

@codecov
Copy link
Copy Markdown

codecov bot commented Jul 14, 2024

Codecov Report

Attention: Patch coverage is 22.22222% with 7 lines in your changes missing coverage. Please review.

Project coverage is 49.25%. Comparing base (18b35d4) to head (5094c24).
Report is 7 commits behind head on main.

Files Coverage Δ
pkg/auth/rbac.go 80.76% <100.00%> (ø)
pkg/bpf/pin.go 57.57% <ø> (ø)
pkg/controller/bypass/bypass_controller.go 37.79% <ø> (ø)
pkg/logger/logger.go 37.93% <ø> (ø)
pkg/controller/ads/ads_processor.go 76.40% <0.00%> (ø)
pkg/controller/ads/cache.go 47.54% <0.00%> (ø)
pkg/controller/telemetry/metric.go 53.78% <0.00%> (ø)
pkg/utils/nettools.go 0.00% <0.00%> (ø)
pkg/controller/workload/workload_processor.go 42.67% <25.00%> (ø)

... and 2 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8dce347...5094c24. Read the comment docs.

@Okabe-Rintarou-0
Copy link
Copy Markdown
Member Author

should ignore codecov here.

Copy link
Copy Markdown
Member

@hzxuzhonghu hzxuzhonghu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we use golangcilint misspell https://golangci-lint.run/usage/linters/#misspell.

@Okabe-Rintarou-0
Copy link
Copy Markdown
Member Author

Okabe-Rintarou-0 commented Jul 15, 2024

Can we use golangcilint misspell https://golangci-lint.run/usage/linters/#misspell.

Maybe it just check the misspell of go files? There are some typo errors in .c files too. Some of them are even fatal, like using defalut instead of default in switch.

Maybe we need to check all kinds of files?

@hzxuzhonghu
Copy link
Copy Markdown
Member

Good to know, make sense then

Copy link
Copy Markdown
Member

@hzxuzhonghu hzxuzhonghu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@kmesh-bot
Copy link
Copy Markdown
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hzxuzhonghu

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@Okabe-Rintarou-0
Copy link
Copy Markdown
Member Author

Okabe-Rintarou-0 commented Jul 15, 2024

@hzxuzhonghu This patch fixes many typo errors which should not be tested. So the codecov should be ignored here.

@hzxuzhonghu hzxuzhonghu added this pull request to the merge queue Jul 15, 2024
Merged via the queue into kmesh-net:main with commit 558040c Jul 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants