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

Update env.sh so that is does not error when running on Mac #15835

Merged
merged 2 commits into from
May 10, 2024

Conversation

bddicken
Copy link
Contributor

@bddicken bddicken commented May 2, 2024

Description

This is a minor fix to examples/common/env.sh so that it does not error out on mac where zsh is the default shell. shopt is bash-specific and does not work on zsh. This fix was suggested by @mattlord while reviewing and discussing this other PR for the docs on the website: vitessio/website#1736

This is my first PR to vitessio/vitess so not sure about other procedures such as backports, etc.

Related Issue(s)

No issue for this.

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Signed-off-by: bddicken <bddicken@gmail.com>
@bddicken bddicken requested a review from deepthi as a code owner May 2, 2024 15:38
Copy link
Contributor

vitess-bot bot commented May 2, 2024

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 NeedsBackportReason If backport labels have been applied to a PR, a justification is required 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 May 2, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone May 2, 2024
@mattlord mattlord added Component: Examples Type: Internal Cleanup and 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 NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels May 2, 2024
examples/common/env.sh Outdated Show resolved Hide resolved
@frouioui
Copy link
Member

frouioui commented May 6, 2024

This is my first PR to vitessio/vitess so not sure about other procedures such as backports, etc.

I would vote for backporting this to previous release branches as people can use the getting started guide / examples from any branch while reading the docs.

@frouioui frouioui added Backport to: release-17.0 Backport to: release-18.0 Needs to be back ported to release-18.0 Backport to: release-19.0 Needs to be back ported to release-19.0 labels May 6, 2024
frouioui
frouioui previously approved these changes May 6, 2024
Copy link
Member

@frouioui frouioui left a comment

Choose a reason for hiding this comment

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

Approving this since it works well on my Mac from zsh. But waiting to resolve @mattlord's comment.

@frouioui frouioui dismissed their stale review May 6, 2024 16:04

I was wrong :)

Signed-off-by: bddicken <bddicken@gmail.com>
@bddicken
Copy link
Contributor Author

bddicken commented May 9, 2024

I apologize for the delay! I guess we missed the backport deadline for the releases earlier this week.

Anyways, PR has been updated with the fix recommended my @mattlord.

Copy link
Contributor

@mattlord mattlord left a comment

Choose a reason for hiding this comment

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

Thanks! ❤️

Copy link

codecov bot commented May 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.43%. Comparing base (f118ba2) to head (2c6ae26).
Report is 82 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #15835      +/-   ##
==========================================
+ Coverage   68.40%   68.43%   +0.02%     
==========================================
  Files        1556     1559       +3     
  Lines      195121   196825    +1704     
==========================================
+ Hits       133479   134702    +1223     
- Misses      61642    62123     +481     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@harshit-gangal harshit-gangal merged commit a49b8c8 into vitessio:main May 10, 2024
93 checks passed
vitess-bot pushed a commit that referenced this pull request May 10, 2024
Signed-off-by: bddicken <bddicken@gmail.com>
vitess-bot pushed a commit that referenced this pull request May 10, 2024
Signed-off-by: bddicken <bddicken@gmail.com>
vitess-bot pushed a commit that referenced this pull request May 10, 2024
Signed-off-by: bddicken <bddicken@gmail.com>
mattlord pushed a commit that referenced this pull request May 10, 2024
…n Mac (#15835) (#15915)

Signed-off-by: bddicken <bddicken@gmail.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
frouioui pushed a commit that referenced this pull request May 10, 2024
…n Mac (#15835) (#15913)

Signed-off-by: bddicken <bddicken@gmail.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
frouioui pushed a commit that referenced this pull request May 10, 2024
…n Mac (#15835) (#15914)

Signed-off-by: bddicken <bddicken@gmail.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backport to: release-18.0 Needs to be back ported to release-18.0 Backport to: release-19.0 Needs to be back ported to release-19.0 Component: Examples Type: Internal Cleanup
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants