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

Use the SDK for Linting #2704

Closed
webern opened this issue Jan 5, 2023 · 1 comment · Fixed by #2793
Closed

Use the SDK for Linting #2704

webern opened this issue Jan 5, 2023 · 1 comment · Fixed by #2793
Assignees
Labels
area/testing Work relating to testing Bottlerocket help wanted Denotes an issue that needs help from a contributor status/icebox Things we think would be nice but are not prioritized type/enhancement New feature or request

Comments

@webern
Copy link
Contributor

webern commented Jan 5, 2023

If we use the local installs of Go and Cargo/Rust to lint the code, we risk breaking every time the compiler updates and we risk having conflicting lints between GitHub actions and developers' local builds. This is especially true with clippy which aggressively adds lints with each update.

We should use the SDK toolchains to perform these lints so that we control the time at which lints change (i.e. when we update the SDK).

 This is why we should be linting with the SDK tool chains instead of locally installed tool chains. Linting rules should only change when we update the SDK.

Originally posted by @webern in #2701 (comment)

@stmcginnis stmcginnis added type/enhancement New feature or request area/testing Work relating to testing Bottlerocket help wanted Denotes an issue that needs help from a contributor status/icebox Things we think would be nice but are not prioritized labels Jan 5, 2023
@bcressey
Copy link
Contributor

We do use the SDK for Go and ShellCheck lints currently; it's just cargo that gets a pass, since we know it's required as a build tool.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/testing Work relating to testing Bottlerocket help wanted Denotes an issue that needs help from a contributor status/icebox Things we think would be nice but are not prioritized type/enhancement New feature or request
Projects
Development

Successfully merging a pull request may close this issue.

4 participants