mirror of
https://github.com/scylladb/scylladb.git
synced 2026-05-14 03:42:14 +00:00
5ea3af067d
to identify misspelling in the code. The GitHub actions in this workflow run codespell when a new pull request is created targetting master or enterprise branch. Errors will be annotated in the pull request. A new entry along with the existing tests like build, unit test and dtest will be added to the "checks" shown in github PR web UI. one can follow the "Details" to find the details of the errors. unfortunately, this check checks all text files unless they are explicitly skipped, not just the new ones added / changed in the PR under test. in other words, if there are 42 misspelling errors in master, and you are adding a new one in your PR, this workflow shows all of the 43 errors -- both the old and new ones. the misspelling in the code hurts the user experience and some time developer's experience, but the text files under test/cql can be sensitive to the text, sometimes, a tiny editing could break the test, so it is added to the skip list. So far, since there are lots of errors identified by the tool, before we address all of them, the identified problem are only annotated, they are not considered as error. so, they don't fail the check. and in this change `only_warn` is set, so the check does not fail even if there are misspellings. this prevents the distractions before all problems are addressed. we can remove this setting in future, once we either fix all the misspellings or add the ignore words or skip files. but either way, the check is not considered as blockers for merging the tested PR, even if this check fails -- the check failure is just represented for information purpose, unless we make it a required in the github settings for the target branch. if want to change this, we can configure it in github's Branch protectionn rule on a per-branch basis, to make this check a must-pass. Signed-off-by: Kefu Chai <kefu.chai@scylladb.com> Closes scylladb/scylladb#16285