k0-board 0.1.0 → 0.1.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/CHANGELOG.md +14 -1
- package/README.md +31 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -6,6 +6,18 @@ All notable changes to this project are documented here. The format follows
|
|
|
6
6
|
|
|
7
7
|
## [Unreleased]
|
|
8
8
|
|
|
9
|
+
## [0.1.1]
|
|
10
|
+
|
|
11
|
+
Documentation, and how a release is made. Nothing about k0 itself changed.
|
|
12
|
+
|
|
13
|
+
### Changed
|
|
14
|
+
|
|
15
|
+
- The README says what the npm package is, how to keep it up to date, and what each command
|
|
16
|
+
does.
|
|
17
|
+
- Releases are published by GitHub Actions through npm's **trusted publishing**, with a signed
|
|
18
|
+
provenance statement and no publishing token kept anywhere — not in the repository secrets,
|
|
19
|
+
not on a laptop. A token that can publish is a token that can be stolen.
|
|
20
|
+
|
|
9
21
|
## [0.1.0]
|
|
10
22
|
|
|
11
23
|
The first public release. k0 existed for a while as one person's tool before this; what changed
|
|
@@ -53,5 +65,6 @@ here is everything that had to change for it to be somebody else's tool as well.
|
|
|
53
65
|
- The personal fixtures k0 grew up on. `test/clean.test.mjs` now fails the build if any of them
|
|
54
66
|
come back.
|
|
55
67
|
|
|
56
|
-
[Unreleased]: https://github.com/alessio-ragni/k0-board/compare/v0.1.
|
|
68
|
+
[Unreleased]: https://github.com/alessio-ragni/k0-board/compare/v0.1.1...HEAD
|
|
69
|
+
[0.1.1]: https://github.com/alessio-ragni/k0-board/compare/v0.1.0...v0.1.1
|
|
57
70
|
[0.1.0]: https://github.com/alessio-ragni/k0-board/releases/tag/v0.1.0
|
package/README.md
CHANGED
|
@@ -19,6 +19,7 @@ doing, and it goes on saying so while you are looking somewhere else.
|
|
|
19
19
|
|
|
20
20
|
|
|
21
21
|
[](https://github.com/alessio-ragni/k0-board/actions/workflows/ci.yml)
|
|
22
|
+
[](https://www.npmjs.com/package/k0-board)
|
|
22
23
|
[](LICENSE)
|
|
23
24
|
|
|
24
25
|
**Contents** · [Install](#install) · [How it is used](#how-it-is-used) ·
|
|
@@ -41,6 +42,36 @@ npx k0-board
|
|
|
41
42
|
That is the whole thing. It tells you everything it is about to change, asks, and only then does
|
|
42
43
|
it. `k0-board uninstall` undoes all of it.
|
|
43
44
|
|
|
45
|
+
k0 is published on npm as [`k0-board`](https://www.npmjs.com/package/k0-board): one package, no
|
|
46
|
+
dependencies, nothing to compile. `npx` fetches it, runs the installer once and leaves nothing
|
|
47
|
+
behind — what stays on the machine is the copy the installer puts in `~/.k0/app`, not an npx
|
|
48
|
+
cache that could be swept away under a running service. Installing it globally with
|
|
49
|
+
`npm install -g k0-board` works too, if you would rather have the command on your PATH.
|
|
50
|
+
|
|
51
|
+
**To update it**, run the installer again with `npx k0-board@latest`: it replaces the copy and
|
|
52
|
+
restarts the service. Your board is never in the way — it lives in `~/.k0/k0.db`, outside
|
|
53
|
+
everything the installer touches, and `uninstall` leaves it there as well.
|
|
54
|
+
|
|
55
|
+
Every release is published by GitHub Actions with a signed **provenance statement**: proof, which
|
|
56
|
+
`npm audit signatures` will check for you, that the tarball was built from a particular commit of
|
|
57
|
+
this repository rather than uploaded by somebody who happened to have a password. (0.1.0 predates
|
|
58
|
+
that and went out from a laptop.)
|
|
59
|
+
|
|
60
|
+
### The commands
|
|
61
|
+
|
|
62
|
+
| | |
|
|
63
|
+
|---|---|
|
|
64
|
+
| `k0-board install` | install and start it — this is what `npx k0-board` runs |
|
|
65
|
+
| `k0-board uninstall` | undo everything install did; your board stays |
|
|
66
|
+
| `k0-board start` | run the server in the foreground, installing nothing |
|
|
67
|
+
| `k0-board restart` | restart the service |
|
|
68
|
+
| `k0-board status` | is it running? exits 0 if it is, 1 if it is not |
|
|
69
|
+
| `k0-board doctor` | what this machine can and cannot do, and why |
|
|
70
|
+
|
|
71
|
+
`--yes` does not ask. `--from-source` points the service at the directory you are in instead of
|
|
72
|
+
copying it, which is what you want while working on k0 itself. `--no-<name>` skips one optional
|
|
73
|
+
change — `--no-lid-sleep`, `--no-shift-enter`. `K0_PORT` moves the board off 4319.
|
|
74
|
+
|
|
44
75
|
From a clone, if you would rather look first:
|
|
45
76
|
|
|
46
77
|
```bash
|