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

build: Exclude generated Tutor configuration from flake8 tests #67

Merged
merged 1 commit into from
Dec 14, 2023

Conversation

fghaas
Copy link
Contributor

@fghaas fghaas commented Dec 14, 2023

Until Tutor 17, just enabling a plugin with tutor plugin enable would not recreate the configuration, meaning the tests/tutor-sandbox/env directory would remain empty.

As of overhangio/tutor#957, however, tutor plugin enable does automatically also run tutor config save, generating a full Tutor configuration.

This means that unless configured otherwise, with Tutor 17 our flake8 checks would test code generated by Tutor, rather than just that generated by our plugin.

Thus, to make our tests not break once we bump our dependencies to support Tutor 17, exclude the tests/tutor-sandbox/env checks from flake8.

Until Tutor 17, just enabling a plugin with "tutor plugin enable"
would not recreate the configuration, meaning the
tests/tutor-sandbox/env directory would remain empty.

As of overhangio/tutor#957, however,
"tutor plugin enable" does automatically also run "tutor config save",
generating a full Tutor configuration.

This means that unless configured otherwise, with Tutor 17 our flake8
checks would test code generated by Tutor, rather than just that
generated by our plugin.

Thus, to make our tests not break once we bump our dependencies to
support Tutor 17, exclude the tests/tutor-sandbox/env checks from
flake8.
@fghaas fghaas changed the title build: Test flake8 from GitHub Actions build: Exclude generated Tutor configuration from flake8 tests Dec 14, 2023
@fghaas fghaas requested a review from mrtmm December 14, 2023 10:33
@fghaas fghaas marked this pull request as ready for review December 14, 2023 10:33
@fghaas
Copy link
Contributor Author

fghaas commented Dec 14, 2023

@mrtmm, FYI: this came up in #66, where flake8 testing on the generated Tutor configuration caused GitHub Actions build failures.

@fghaas fghaas merged commit 18ee120 into hastexo:main Dec 14, 2023
8 checks passed
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.

2 participants