pipe-kan 0.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +92 -0
- package/dist/pipe-kan.js +817 -0
- package/dist/ui/assets/index-DHk68jTP.js +14 -0
- package/dist/ui/assets/index-HGWYfGrG.css +2 -0
- package/dist/ui/index.html +26 -0
- package/fixtures/issues.json +208 -0
- package/package.json +54 -0
package/README.md
ADDED
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# pipe-kan
|
|
2
|
+
|
|
3
|
+
Local Kanban for [jira-cli](https://github.com/ankitpokhrel/jira-cli). The first release changes Jira only by running jira-cli.
|
|
4
|
+
|
|
5
|
+
## Run
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
bunx pipe-kan
|
|
9
|
+
# or
|
|
10
|
+
npx pipe-kan
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Opens `http://127.0.0.1:5173`. No clone, no `bun install`. `bunx` / `npx` installs the published package into a cache and runs it.
|
|
14
|
+
|
|
15
|
+
First paint is the Fixture. If `jira` is on PATH, the process then Refresh-es from your existing `jira init`. If not, Refresh and Move use the in-process store.
|
|
16
|
+
|
|
17
|
+
Until npm has a release, from a clone: `bun run build && bun dist/pipe-kan.js`.
|
|
18
|
+
|
|
19
|
+
- Left: Epics. Center: Cards (one Column per status in the payload). Right: Open URL; remote Jira is a link, not an iframe.
|
|
20
|
+
- Drop a Card on a Column to Move (`jira issue move`).
|
|
21
|
+
- Same-Column drop and column reorder do nothing.
|
|
22
|
+
- Theme is stored in `localStorage`.
|
|
23
|
+
|
|
24
|
+
LAN: `HOST=0.0.0.0 bunx pipe-kan`.
|
|
25
|
+
|
|
26
|
+
## Work Jira
|
|
27
|
+
|
|
28
|
+
Use your existing `jira init` config. Do not set `JIRA_CONFIG_FILE` to the Fixture file.
|
|
29
|
+
|
|
30
|
+
```sh
|
|
31
|
+
export JIRA_API_TOKEN=... # only if jira-cli does not already have it
|
|
32
|
+
bunx pipe-kan
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Scope flags start empty. Add `-a you@work.com` or `-s~Done` if you want a tighter list, then Refresh.
|
|
36
|
+
|
|
37
|
+
## Fake Jira
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
JIRA_CONFIG_FILE=/tmp/pipe-kan/jira.config.yml JIRA_API_TOKEN=fake bunx pipe-kan
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Boot writes that Fake Jira config (path is also printed) and points it at this origin.
|
|
44
|
+
|
|
45
|
+
## Pipe
|
|
46
|
+
|
|
47
|
+
```sh
|
|
48
|
+
jira issue list --raw | bunx pipe-kan
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Pipe is the first Board. Refresh and Move still go through `jira` when it is on PATH.
|
|
52
|
+
|
|
53
|
+
## Env
|
|
54
|
+
|
|
55
|
+
| Var | Default | Role |
|
|
56
|
+
| --- | --- | --- |
|
|
57
|
+
| `HOST` | `127.0.0.1` | bind address |
|
|
58
|
+
| `PORT` | `5173` | bind port |
|
|
59
|
+
| `JIRA_BIN` | `jira` | binary name or path |
|
|
60
|
+
| `JIRA_CONFIG_FILE` | jira-cli default | set only for Fake Jira |
|
|
61
|
+
| `JIRA_API_TOKEN` | jira-cli default | Work Jira token if needed |
|
|
62
|
+
|
|
63
|
+
## Limits
|
|
64
|
+
|
|
65
|
+
- Write-back is `jira issue move` only. Intra-column rank is not persisted.
|
|
66
|
+
- Never a direct Jira REST Write-back.
|
|
67
|
+
- Work Jira needs `jira` on PATH and a token. This repo does not ship one.
|
|
68
|
+
|
|
69
|
+
## Check
|
|
70
|
+
|
|
71
|
+
```sh
|
|
72
|
+
bun test
|
|
73
|
+
bun run typecheck
|
|
74
|
+
bun run build
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
Contributors still `bun install` and `bun run dev` (Vite). `bun run build` writes the published CLI to `dist/pipe-kan.js`.
|
|
78
|
+
|
|
79
|
+
## Version
|
|
80
|
+
|
|
81
|
+
Pushes to `main` run `bun audit --audit-level=high`, tests, then [semantic-release](https://semantic-release.gitbook.io). High or critical dependency CVEs fail the job before a tag or publish. Dependabot opens weekly PRs for `bun` and GitHub Actions. It reads conventional commits since the last `v*` tag:
|
|
82
|
+
|
|
83
|
+
| Commit | Bump |
|
|
84
|
+
| --- | --- |
|
|
85
|
+
| `fix:` | patch (`0.1.0` → `0.1.1`) |
|
|
86
|
+
| `feat:` | minor (`0.1.0` → `0.2.0`) |
|
|
87
|
+
| `feat!:` or `BREAKING CHANGE:` | major |
|
|
88
|
+
| `docs:`, `chore:`, `test:` | none |
|
|
89
|
+
|
|
90
|
+
It writes `package.json`, tags `vX.Y.Z`, and opens a GitHub Release. npm publish is wired (`bin`, `files`, `bun run build` on CI) and waits on repo secret `NPM_TOKEN`. After that secret exists, set `npmPublish` to `true` in `.releaserc.json`.
|
|
91
|
+
|
|
92
|
+
First Board is tagged `v0.1.0`. Later `fix:` / `feat:` commits on `main` bump from there. Without a `v*` tag the first release is `1.0.0`.
|