bitpipe/README.org at main · baongoc124/bitpipe · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
#+title: bitpipe
#+author: Ngoc

Trigger and monitor Bitbucket Pipelines from Emacs.

* Installation

#+begin_src emacs-lisp
(use-package bitpipe
  :vc (:url "https://github.com/baongoc124/bitpipe.git"
       :rev :newest)
  :config
  (setq bitpipe-workspace "my-workspace"
        bitpipe-email "me@example.com"
        bitpipe-api-token "your-app-password"))
#+end_src

* Configuration

| Variable                | Description                                          | Default |
|-------------------------+------------------------------------------------------+---------|
| =bitpipe-workspace=     | Bitbucket workspace slug                             | =nil=   |
| =bitpipe-email=         | Atlassian account email                              | =nil=   |
| =bitpipe-api-token=     | Bitbucket app password                               | =nil=   |
| =bitpipe-poll-interval= | Seconds between status polls                         | =7=     |
| =bitpipe-use-ivy=       | Use =ivy-read= instead of =completing-read=          | =nil=   |

* Usage

- =M-x bitpipe-run= — trigger a pipeline (choose branch and pipeline interactively)
- =M-x bitpipe-log= — browse recent pipeline runs

In the log buffer:

| Key       | Action                   |
|-----------+--------------------------|
| =RET=     | Open pipeline in browser |
| =g=       | Refresh                  |
| =n= / =p= | Next / previous row      |

* License

GPL-3.0-or-later