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

ci: Move spellchecks to format_pre #17028

Merged
merged 1 commit into from
Jun 21, 2021
Merged

Conversation

phlax
Copy link
Member

@phlax phlax commented Jun 17, 2021

Signed-off-by: Ryan Northey [email protected]

Commit Message: ci: Move spellchecks to format_pre
Additional Description:
Risk Level:
Testing:
Docs Changes:
Release Notes:
Platform Specific Features:
[Optional Runtime guard:]
[Optional Fixes #Issue]
[Optional Deprecated:]
[Optional API Considerations:]

@phlax
Copy link
Member Author

phlax commented Jun 17, 2021

im trying to understand why we have 2 sets of spellchecking

afaict also spellcheck_pedantic fix errors after the first incorrect spelling - and doesnt fix anything - so im wondering if there is any point to running the fix - ie just run the check

@repokitteh-read-only
Copy link

CC @envoyproxy/api-shepherds: Your approval is needed for changes made to api/envoy/.
envoyproxy/api-shepherds assignee is @mattklein123
CC @envoyproxy/api-watchers: FYI only for changes made to api/envoy/.

🐱

Caused by: #17028 was synchronize by phlax.

see: more, trace.

@phlax phlax force-pushed the format-spelling branch from da29fa3 to f4f024c Compare June 18, 2021 08:22
@phlax phlax changed the title [WIP] ci: Move spellchecks to format_pre ci: Move spellchecks to format_pre Jun 18, 2021
@phlax
Copy link
Member Author

phlax commented Jun 18, 2021

on the basis that i wasnt able to trigger the misspell spelling check, and that the fix doesnt work non-interactively for the pedantic spelling (as discussed offline) i have removed the first and set the latter to check only, as well as moving the spell checking to the format_pre job

cc @zuercher

@phlax phlax marked this pull request as ready for review June 18, 2021 08:47
@phlax phlax force-pushed the format-spelling branch from f4f024c to aa9a458 Compare June 18, 2021 11:33
@phlax phlax removed the api label Jun 18, 2021
@@ -419,22 +418,6 @@ elif [[ "$CI_TARGET" == "check_format" ]]; then
"${ENVOY_SRCDIR}"/tools/code_format/check_format.py check
BAZEL_BUILD_OPTIONS="${BAZEL_BUILD_OPTIONS[*]}" "${ENVOY_SRCDIR}"/tools/proto_format/proto_format.sh check --test
exit 0
elif [[ "$CI_TARGET" == "check_spelling" ]]; then
Copy link
Contributor

Choose a reason for hiding this comment

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

hm, do you think we should keep these around for folks who are used to running things this way, or only want to do spelling not all pre checks?

We can also remove it now and add it back if anyone complains but I have these aliased so I'd mildly prefer to keep but I can totally update my aliases too :-)

Copy link
Member Author

Choose a reason for hiding this comment

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

i think we need to remove these - i think the do_ci.sh switchboard is a bit of an anti pattern - the related readme has been updated

@@ -58,6 +58,9 @@ bazel run "${BAZEL_BUILD_OPTIONS[@]}" //tools/code_format:python_check -- --diff
CURRENT=extensions
bazel run "${BAZEL_BUILD_OPTIONS[@]}" //tools/extensions:extensions_check

CURRENT=spelling
"${ENVOY_SRCDIR}"/tools/spelling/check_spelling_pedantic.py --mark check
Copy link
Contributor

Choose a reason for hiding this comment

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

why delete the other spell check? I thought they caught different things?

Copy link
Member Author

Choose a reason for hiding this comment

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

afaict one is not catching anything

when this was discussed in the maintainer channel it was ~agreed to remove

Copy link
Contributor

Choose a reason for hiding this comment

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

ah I must have been out

@phlax phlax merged commit 420d2b9 into envoyproxy:main Jun 21, 2021
@RyanTheOptimist
Copy link
Contributor

It looks like this PR broke some scripts (well shell aliases) I was using to check the spelling. (though I didn't notice immediately). Perhaps in the future it would be a good idea to announce workflow changes like this so developer know what they need to do?

leyao-daily pushed a commit to leyao-daily/envoy that referenced this pull request Sep 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants