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.

Sign up for GitHub

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

Jump to bottom

add --help option and handle unexpected arguments #182

Merged
merged 20 commits into from
Apr 29, 2021
Merged

add --help option and handle unexpected arguments #182

merged 20 commits into from
Apr 29, 2021

Conversation

glennmusa
Copy link
Contributor

Description

This change makes two updates to end-user facing scripts:

  • Maps -h from --hub-sub-id to --help to print the argument list for commands that take named arguments
  • Maps -u to --hub-sub-id
  • Handles unexpected arguments
    • (e.g. if I call src/deploy.sh --foo bar I receive a ERROR: Unexpected argument --foo and the command doesn't execute)

Issue reference

The issue this PR will close: #164, #181

Checklist

Please make sure you've completed the relevant tasks for this PR, out of the following list:

  • Code compiles or validates correctly
  • BASH scripts have been validated using shellcheck
  • All tests pass (manual and automated)
  • The documentation is updated to cover any new or changed features
  • Markdown files have been linted using the recommended linter. (See .vscode/extensions.json.)
  • Relevant issues are linked to this PR

glennmusa and others added 19 commits April 22, 2021 21:50
@glennmusa
add validation for azure region and terraforme environment
652052c
@Breanna-Stryker @glennmusa
Docker Export/Load (#167)
acb07d3 
* Various fixes and refactor to allow for export and load

* Update documentation.

* Abstract export code to own file, extend to allow file names

* Fix various.

Co-authored-by: Bree Stryker <bstryker@DESKTOP-3AGKDHF.localdomain>
@glennmusa
match on whole word
400258e
@glennmusa
remove export docker strategy
7fadcc7
@glennmusa
order of operations for login
3121af1
@glennmusa
whitespace
f657264
@glennmusa
validate before notifying of defaults
ed66200
@glennmusa
Merge branch 'main' into glenn/validatelocation
d3b9a38
@glennmusa
case insensitive match
226e64e
@glennmusa
update cloud names in tf env check
d0dd3fd
@glennmusa
simplify defaults
4f060ba
@glennmusa
accurately describe shellcheck supressions
f212723
@glennmusa
update docs
e6e32e5
@glennmusa
update docs
6817a43
@glennmusa
add help messages where users provide named args
7f12c7c
@glennmusa
add a catch for unexpected arguments
5c8c14a
@glennmusa
Merge branch 'main' into glenn/addhelp
b933c69
@glennmusa
update docs
97f41e3
@glennmusa
update docs
aeea4b3
@glennmusa glennmusa enabled auto-merge (squash) April 28, 2021 14:26
brooke-hamilton
brooke-hamilton approved these changes Apr 29, 2021
View reviewed changes
Copy link
Contributor

@brooke-hamilton brooke-hamilton left a comment

Choose a reason for hiding this comment

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

I tested all the affected scripts with -h and --help. It's awesome that they all have the same functionality.

@glennmusa glennmusa merged commit d9364d5 into main Apr 29, 2021
@glennmusa glennmusa deleted the glenn/addhelp branch April 29, 2021 14:18
@brooke-hamilton brooke-hamilton mentioned this pull request Apr 29, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@brooke-hamilton brooke-hamilton brooke-hamilton approved these changes

@sstjean sstjean Awaiting requested review from sstjean

@Phydeauxman Phydeauxman Awaiting requested review from Phydeauxman

@Breanna-Stryker Breanna-Stryker Awaiting requested review from Breanna-Stryker

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

End-user facing scripts should have a --help -h option
3 participants
@glennmusa @brooke-hamilton @Breanna-Stryker