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

fix: Collision with --global flags #194

Merged
merged 1 commit into from
Sep 29, 2021
Merged

Conversation

raulb
Copy link
Member

@raulb raulb commented Sep 29, 2021

Meroxa CLI used it before to specify the path of a configuration file, while connectors still use it the same as well.

Description of change

Updates global configuration flag to meroxa-config to free up --config for connector commands.

Type of change

  • New feature
  • Bug fix
  • Refactor
  • Documentation

How was this tested?

  • Unit Tests
  • Tested in staging

Demo

Before this pull-request

❯ meroxa help | grep config
  config      Manage your Meroxa CLI configuration
      --config string      config file

After this pull-request

❯ .m help | grep config    
  config      Manage your Meroxa CLI configuration
      --meroxa-config string   meroxa configuration file

Additional references

Fixes https://meroxa.zendesk.com/agent/tickets/121

  • Acceptance tests also need to be updated.

Documentation updated

https://github.com/meroxa/meroxa-docs/commit/a0d441038856553e326af103296fa3562c0fbde5

@raulb raulb self-assigned this Sep 29, 2021
@ahamidi
Copy link
Member

ahamidi commented Sep 29, 2021

If it's used exclusively to point to a config file, then maybe we should make the command --config-file.

Incidentally I'm pretty sure I accidentally found a work around by using -c for connector configs.

@raulb
Copy link
Member Author

raulb commented Sep 29, 2021

@ahamidi re: -c you're right! it didn't occur to me 🤦‍♂️.

Regarding --config-file, that also works. I wasn't really sure about what name to use, so I'll take that one as a good suggestion. Thank you.

@ahamidi
Copy link
Member

ahamidi commented Sep 29, 2021

Actually we may want to be explicit and name it --global-config-file or --cli-config-file or something along those lines so that we free up the ability to pass connector configs as files too.

Meroxa CLI used it before to specify the path of a configuration file, while connectors still use it the same as well.
Copy link
Member

@ahamidi ahamidi left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@raulb raulb merged commit e8c3e26 into master Sep 29, 2021
@raulb raulb deleted the update-meroxa-global-flag branch September 29, 2021 15:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants