README.md in dri-0.1.0 vs README.md in dri-0.1.1

- old
+ new

@@ -5,13 +5,13 @@ Welcome to your new gem! DRI is a CLI ready to help: - Fetching failing test cases by pipeline - Reporting at the end of the timezone shift - View today's newest and untriaged failures -- Take actions on failures +- Mark actions on failures -... and more. +... and more ## Installation To install the `dri` gem: @@ -53,14 +53,17 @@ - [1. init](#1-init) - [2. profile](#2-profile) - [3. fetch](#3-fetch) - failures - testcases + - triaged - [4. publish](#4-publish) - report - [5. rm](#5-rm) - emoji + - profile + - reports - [6. version](#6-version) #### 1. init ```shell @@ -85,18 +88,27 @@ ``` Fetches today's opened failures and lists them according to their triage status. Helpful to understand if there are missing recent failures to be reviewed. +To surface most urgent issues pass the `--urgent` flag to see issues that are both +in `canary` and `staging-canary` pipelines just during today's timespan. + ```shell $ dri fetch testcases ``` Fetches test cases that failing currently and groups them by pipeline. To filter the pipelines, pass the `--filter-pipelines` options to multi-select the pipelines you wish to consult. (Use `Space` to select an option) +```shell +$ dri fetch triaged +``` + +Fetches triaged failures which use the triage emoji specified in `dri profile`. + #### 4. publish ```shell $ dri publish report ``` @@ -107,18 +119,46 @@ ```shell $ dri publish report --format=list # formats the report in a list $ dri publish report --format=table # formats the report in a table (default) $ dri publish report --dry-run # the report is only generated locally +$ dri publish report --actions # activate the actions prompt for each failure ``` +**Note:** These options above can be combined like: + +```shell +$ dri publish report --format=list --dry-run --actions +``` + +**Actions** + +When using `--actions` a set of actions are prompt on each failure. Use `Space` to +mark several actions: `pinged SET`, `quarantined`, `reproduced`, `transient`. +Hitting `Enter` without a selected action will skip marking the actions for a given +failure. + #### 5. rm ```shell $ dri rm emoji ``` Removes the triage emoji from all triaged issues. + +```shell +$ dri rm reports +``` + +When using `$ dri publish report --dry-run` to download the reports locally instead +of uploading to the latest Pipeline Triage Issue, an `/handover_reports/` folder +created to store these reports. This command removes this folder and subsequent reports stored in it. + +```shell +$ dri rm profile +``` + +Removes the profile currently in use. #### 6. version ```shell $ dri version