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

workflow: misspell does not look to be working as intended #415

Open
KevFan opened this issue Jul 21, 2023 · 1 comment
Open

workflow: misspell does not look to be working as intended #415

KevFan opened this issue Jul 21, 2023 · 1 comment
Labels
area/dependencies Pull requests that update a dependency file area/doc Improvements or additions to documentation kind/enhancement New feature or request kind/investigation participation/good first issue Good for newcomers

Comments

@KevFan
Copy link
Contributor

KevFan commented Jul 21, 2023

Describe the bug
Follow up from #414, misspell step in the workflow had not detected the typos indicating a possible usage issue

Help us Reproduce it

  1. Make a PR with a typo
  2. Get workflow logs for misspell
  3. The following is logged, indicating no misspellings
Run set -e
 Running github.com/client9/misspell with reviewdog 🐶 ...
  reviewdog: This GitHub token doesn't have write permission of Review API [1], 
  reviewdog: Reporting results for "github.com/client9/misspell"
  reviewdog: No results found for "github.com/client9/misspell". 0 results found outside diff.
  so reviewdog will report results via logging command [2] and create annotations similar to
  github-pr-check reporter as a fallback.
  [1]: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target, 
  [2]: https://help.github.com/en/actions/automating-your-workflow-with-github-actions/development-tools-for-github-actions#logging-commands

Expected behavior
Mispell step detects obvious typo mistakes

@KevFan KevFan added kind/bug Something isn't working area/doc Improvements or additions to documentation labels Jul 21, 2023
@KevFan KevFan moved this to Needs refinement in Kuadrant Service Protection Jul 21, 2023
@KevFan
Copy link
Contributor Author

KevFan commented Jul 24, 2023

Misspell might actually be running but simply just not good enough to detect the typos. This issue might instead be to find possible alternatives (e.g. https://github.com/crate-ci/typos) if this is the case and the preference

@KevFan KevFan added kind/enhancement New feature or request participation/good first issue Good for newcomers area/dependencies Pull requests that update a dependency file kind/investigation and removed kind/bug Something isn't working labels Jul 27, 2023
@guicassolato guicassolato added this to the v0.17.x milestone Dec 19, 2023
@guicassolato guicassolato modified the milestones: v0.17.x, v0.18.x Feb 22, 2024
@guicassolato guicassolato modified the milestones: v0.18.x, v0.19.x Aug 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/dependencies Pull requests that update a dependency file area/doc Improvements or additions to documentation kind/enhancement New feature or request kind/investigation participation/good first issue Good for newcomers
Projects
Status: No status
Status: Needs refinement
Development

No branches or pull requests

2 participants