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

Add -h help flag #655

Open
ashanhol opened this issue May 5, 2023 · 0 comments
Open

Add -h help flag #655

ashanhol opened this issue May 5, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@ashanhol
Copy link
Contributor

ashanhol commented May 5, 2023

Problem:
Our wiki's out of date. We're constantly breaking deployer without backwards compatibility. Some of this is inevitable, but it'd help a lot if we had a help flag that showed our Configuration options (and required ones) at any point of running the deployer.

Solution:
Add -h flag, ideally one that hooks into Configuration.cs so it can be kept up to date whenever we make code changes.

Additional context
./deploy-cromwell-on-azure-linux -h
./deploy-cromwell-on-azure-linux --help
deploy-cromwell-on-azure-win -h
deploy-cromwell-on-azure-win --help

deploy-cromwell-on-azure* --BadConfigOption Welcome to the Cromwell on Azure Deployer! Please run deploy-cromwell-on-azure -h for a list of required and available configuration

Sister issue for TES: microsoft/ga4gh-tes#218

@ashanhol ashanhol added documentation Improvements or additions to documentation enhancement New feature or request labels May 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant