Skip to content

Commit

Permalink
docs(run): clarify run completion notification info
Browse files Browse the repository at this point in the history
  • Loading branch information
benelan committed Jun 4, 2024
1 parent ce8ec79 commit 534ee01
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,15 +197,16 @@ that can be used with any `gh fzf` command:
- `alt-x`: Cancel the selected run (see `gh run cancel --help`)
- `alt-p`: Open `gh fzf pr` filtered for the selected run's branch as HEAD
(see [`pr`](#pr))
- `alt-n`: Create a desktop notification with conclusion info when the
selected run ends. The supported notification tools (tried in order) are
`dunstify`, `notify-send`, and `osascript`. The notification has
[actions](https://dunst-project.org/documentation#ACTIONS) for rerun, view
logs, etc. when using `dunstify`.
> [!NOTE]
> The process that watches the run and notifies on completion is executed in
> the background, however it is still tied to `gh-fzf`. This means closing
> `gh-fzf` will prevent the notification from occurring.
- `alt-n`: Create a desktop notification with the conclusion (failed, passed,
etc.) when the selected run ends. The supported notification tools (tried in
order) are `dunstify`, `notify-send`, and `osascript`. The notification has
[actions](https://dunst-project.org/documentation#ACTIONS) for "view logs"
and "open in browser" when using `dunstify`. There is an additional
"download artifacts" or "rerun failed jobs" action depending on whether the
run passed or failed, respectively.
> **NOTE:** The run watching process is executed in the background, so
> closing `gh-fzf` won't prevent the desktop notification from displaying.
> Use `killall gh` to end all `gh` processes, including the run watcher.
- `alt-b`: Filter the list, showing runs from the current branch
- `alt-u`: Filter the list, showing runs triggered by you
- `alt-f`: Filter the list, showing failed runs
Expand Down

0 comments on commit 534ee01

Please sign in to comment.