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

Tell shellcheck to follow sourced files #14377

Merged
merged 1 commit into from
Oct 27, 2023
Merged

Conversation

mattlord
Copy link
Contributor

@mattlord mattlord commented Oct 26, 2023

Description

This is a minor improvement that will help eliminate unhelpful shellcheck errors — surfaced via the pre-commit hooks: .git/hooks/pre-commit -> misc/git/hooks/shellcheck — as well as potentially surface new things.

It does this by adding the -x shell flag so that shellcheck will follow the files and validate them as well. Here's an example:

❯ shellcheck tools/remove_dependencies.sh

In tools/remove_dependencies.sh line 21:
source build.env
       ^-------^ SC1091 (info): Not following: build.env was not specified as input (see shellcheck -x).

For more information:
  https://www.shellcheck.net/wiki/SC1091 -- Not following: build.env was not ...

❯ shellcheck -x tools/remove_dependencies.sh

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on the CI
  • Documentation was added or is not required

@mattlord mattlord added Type: Internal Cleanup Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Build/CI labels Oct 26, 2023
@mattlord mattlord requested a review from deepthi as a code owner October 26, 2023 17:34
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Oct 26, 2023

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Oct 26, 2023
@github-actions github-actions bot added this to the v19.0.0 milestone Oct 26, 2023
@frouioui frouioui removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request labels Oct 26, 2023
@mattlord mattlord requested review from a team and removed request for deepthi October 26, 2023 17:39
@mattlord mattlord merged commit 823b0a6 into vitessio:main Oct 27, 2023
117 of 119 checks passed
@mattlord mattlord deleted the shellcheck branch October 27, 2023 04:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Build/CI Type: Enhancement Logical improvement (somewhere between a bug and feature) Type: Internal Cleanup
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants