diff --git a/travis/3-forecast.md b/travis/3-forecast.md index eedc077..5c1df95 100644 --- a/travis/3-forecast.md +++ b/travis/3-forecast.md @@ -90,7 +90,24 @@ Additionally, these metrics are defined for each queue of runners defined in Tra You can examine the available options for the `forecast` command by running `gh actions-importer forecast --help`. When you do this you will see the `--source-file-path` option: -![img](https://user-images.githubusercontent.com/19557880/190511652-081ae8c3-c37e-4c5f-9e7f-8fcd9fe63b3a.png) +```console +$ gh actions-importer forecast travis-ci -h +Options: + -g, --travis-ci-organization The Travis CI organization name. + -u, --travis-ci-instance-url The URL of the Travis CI instance. + -t, --travis-ci-access-token Access token for the Travis CI instance. + --source-file-path The file path(s) to existing jobs data. + -o, --output-dir (REQUIRED) The location for any output files. + --start-date The start date of the forecast analysis in YYYY-MM-DD format. [default: + 10/31/2022 11:13:24 AM] + --time-slice The time slice in seconds to use for computing concurrency metrics. [default: + 60] + --credentials-file The file containing the credentials to use. + --no-telemetry Boolean value to disallow telemetry. + --no-ssl-verify Disable ssl certificate verification. + --no-http-cache Disable caching of http responses. + -?, -h, --help Show help and usage information +``` You can use the `--source-file-path` CLI option to combine data from multiple reports into a single report. This becomes useful if you use multiple CI/CD providers and want to get a holistic view of the runner usage. This works by using the `.json` files generated by `forecast` commands as space-delimited values for the `--source-file-path` CLI option. Optionally, this value could be a glob pattern to dynamically specify the list of files (e.g. `**/*.json`).