Kuadrant / authorino

K8s-native AuthN/AuthZ service to protect your APIs.
Apache License 2.0
194 stars 30 forks source link

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

Open KevFan opened 1 year ago

KevFan commented 1 year ago

Describe the bug Follow up from https://github.com/Kuadrant/authorino/pull/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.

Expected behavior Mispell step detects obvious typo mistakes

KevFan commented 1 year ago

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