vitess icon indicating copy to clipboard operation
vitess copied to clipboard

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

Open bddicken opened this issue 9 months ago • 2 comments

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: https://github.com/vitessio/website/pull/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

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

bddicken avatar May 02 '24 15:05 bddicken

Review Checklist

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

General

  • [x] Ensure that the Pull Request has a descriptive title.
  • [x] 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[bot] avatar May 02 '24 15:05 vitess-bot[bot]

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 avatar May 06 '24 15:05 frouioui

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.

bddicken avatar May 09 '24 23:05 bddicken

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar May 10 '24 05:05 codecov[bot]