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: Add shellcheck step to lint job #1061

Merged
merged 3 commits into from
Jan 31, 2024
Merged

ci: Add shellcheck step to lint job #1061

merged 3 commits into from
Jan 31, 2024

Conversation

marun
Copy link

@marun marun commented Jan 23, 2024

#lintallthethings!

We lint code, why not shell scripts? In addition to simplifying the avoidance of common shell errors, the shellcheck wiki has lots of documentation for all the error types it checks for.

Testing

In addition to CI, local testing on arm64 linux and macos verified the logic for downloading and using a local (vs one in the path) shellcheck.

Related: AvalancheGo PR

@marun marun added the ci label Jan 23, 2024
@marun marun self-assigned this Jan 23, 2024
@marun marun force-pushed the ci-shellcheck branch 4 times, most recently from 0cfb8e4 to 3e7d9b4 Compare January 24, 2024 07:55
@marun marun marked this pull request as ready for review January 24, 2024 07:55
joshua-kim
joshua-kim previously approved these changes Jan 24, 2024
Copy link
Collaborator

@ceyonur ceyonur left a comment

Choose a reason for hiding this comment

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

some scripts are from upstream repo, maybe we should exclude them from spellcheck. other changes LGTM.

cmd/evm/transition-test.sh Outdated Show resolved Hide resolved
metrics/validate.sh Outdated Show resolved Hide resolved
Copy link
Collaborator

@ceyonur ceyonur left a comment

Choose a reason for hiding this comment

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

some scripts are from upstream repo, maybe we should exclude them from spellcheck. other changes LGTM.

@marun
Copy link
Author

marun commented Jan 24, 2024

some scripts are from upstream repo, maybe we should exclude them from spellcheck. other changes LGTM.

Reverted changes to the named upstream tests and updated the new script to support ignoring those files.

@ceyonur ceyonur enabled auto-merge (squash) January 31, 2024 13:19
@ceyonur ceyonur merged commit 965e4b0 into master Jan 31, 2024
10 checks passed
@ceyonur ceyonur deleted the ci-shellcheck branch January 31, 2024 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants