Skip to content

Move --update-<importer> args under their corresponding sections in help output #120

@Gerrrr

Description

@Gerrrr

Today:

run otava analyze --help
usage: otava analyze [-h] [--graphite-url GRAPHITE_URL] [--grafana-url GRAFANA_URL]
                     [--grafana-user GRAFANA_USER] [--grafana-password GRAFANA_PASSWORD]
                     [--slack-token SLACK_TOKEN] [--postgres-hostname POSTGRES_HOSTNAME]
                     [--postgres-port POSTGRES_PORT] [--postgres-username POSTGRES_USERNAME]
                     [--postgres-password POSTGRES_PASSWORD]
                     [--postgres-database POSTGRES_DATABASE]
                     [--bigquery-project-id BIGQUERY_PROJECT_ID]
                     [--bigquery-dataset BIGQUERY_DATASET]
                     [--bigquery-credentials BIGQUERY_CREDENTIALS] [--update-grafana]
                     [--update-postgres] [--update-bigquery]
                     [--notify-slack NOTIFY_SLACK [NOTIFY_SLACK ...]] [--cph-report-since DATE]
                     [--output {log,json,regressions_only}] [--branch [STRING]] [--metrics LIST]
                     [--attrs LIST] [--since-commit STRING | --since-version STRING |
                     --since DATE] [--until-commit STRING | --until-version STRING | --until DATE]
                     [--last COUNT] [-P, --p-value PVALUE] [-M MAGNITUDE] [--window WINDOW]
                     [--orig-edivisive ORIG_EDIVISIVE]
                     tests [tests ...]

positional arguments:
  tests                 name of the test or group of the tests

options:
  -h, --help            show this help message and exit
   --update-grafana      Update Grafana dashboards with appropriate annotations of change points
  --update-postgres     Update PostgreSQL database results with change points
  --update-bigquery     Update BigQuery database results with change points
...
Grafana Options:
  Options for Grafana configuration

  --grafana-url GRAFANA_URL
                        Grafana server URL [env var: GRAFANA_ADDRESS]
  --grafana-user GRAFANA_USER
                        Grafana server user [env var: GRAFANA_USER]
  --grafana-password GRAFANA_PASSWORD
                        Grafana server password [env var: GRAFANA_PASSWORD]
...
PostgreSQL Options:
  Options for PostgreSQL configuration

  --postgres-hostname POSTGRES_HOSTNAME
                        PostgreSQL server hostname [env var: POSTGRES_HOSTNAME]
  --postgres-port POSTGRES_PORT
                        PostgreSQL server port [env var: POSTGRES_PORT]
  --postgres-username POSTGRES_USERNAME
                        PostgreSQL username [env var: POSTGRES_USERNAME]
  --postgres-password POSTGRES_PASSWORD
                        PostgreSQL password [env var: POSTGRES_PASSWORD]
  --postgres-database POSTGRES_DATABASE
                        PostgreSQL database name [env var: POSTGRES_DATABASE]
...
BigQuery Options:
  Options for BigQuery configuration

  --bigquery-project-id BIGQUERY_PROJECT_ID
                        BigQuery project ID [env var: BIGQUERY_PROJECT_ID]
  --bigquery-dataset BIGQUERY_DATASET
                        BigQuery dataset [env var: BIGQUERY_DATASET]
  --bigquery-credentials BIGQUERY_CREDENTIALS
                        BigQuery credentials file [env var: BIGQUERY_VAULT_SECRET]
...

Instead, the output should look more like:

Grafana Options:
  Options for Grafana configuration

  --grafana-url GRAFANA_URL
                        Grafana server URL [env var: GRAFANA_ADDRESS]
  --grafana-user GRAFANA_USER
                        Grafana server user [env var: GRAFANA_USER]
  --grafana-password GRAFANA_PASSWORD
                        Grafana server password [env var: GRAFANA_PASSWORD]
  --update-grafana      Update Grafana dashboards with appropriate annotations of change points
...

PostgreSQL Options:
  Options for PostgreSQL configuration

  --postgres-hostname POSTGRES_HOSTNAME
                        PostgreSQL server hostname [env var: POSTGRES_HOSTNAME]
  --postgres-port POSTGRES_PORT
                        PostgreSQL server port [env var: POSTGRES_PORT]
  --postgres-username POSTGRES_USERNAME
                        PostgreSQL username [env var: POSTGRES_USERNAME]
  --postgres-password POSTGRES_PASSWORD
                        PostgreSQL password [env var: POSTGRES_PASSWORD]
  --postgres-database POSTGRES_DATABASE
                        PostgreSQL database name [env var: POSTGRES_DATABASE]
  --update-postgres     Update PostgreSQL database results with change points
...

BigQuery Options:
  Options for BigQuery configuration

  --bigquery-project-id BIGQUERY_PROJECT_ID
                        BigQuery project ID [env var: BIGQUERY_PROJECT_ID]
  --bigquery-dataset BIGQUERY_DATASET
                        BigQuery dataset [env var: BIGQUERY_DATASET]
  --bigquery-credentials BIGQUERY_CREDENTIALS
                        BigQuery credentials file [env var: BIGQUERY_VAULT_SECRET]
  --update-bigquery     Update BigQuery database results with change points

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions