otaflow 0.1.1 → 0.2.0
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 +20 -3
- package/dist/otaflow.mjs +150 -139
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -52,10 +52,23 @@ otaflow resume --channel production
|
|
|
52
52
|
otaflow list # channels, heads, recent updates
|
|
53
53
|
```
|
|
54
54
|
|
|
55
|
-
`publish` refuses a dirty git tree and a commit that is already a channel's head, and refuses an update whose bundle contains values from your `.env` files.
|
|
55
|
+
`login` opens the browser page for you (`--no-browser` only prints the link). `publish` refuses a dirty git tree and a commit that is already a channel's head, and refuses an update whose bundle contains values from your `.env` files.
|
|
56
56
|
|
|
57
57
|
A rollback is a new update that carries an older update's content. Each publish also signs, ahead of time, the rollbacks that could undo it, so a manager can roll back from the dashboard or with `otaflow rollback --prepared` **without** the signing key.
|
|
58
58
|
|
|
59
|
+
## Your own bucket
|
|
60
|
+
|
|
61
|
+
By default an app's updates are stored by Otaflow and count against your plan. To keep them in a bucket you own (S3, Cloudflare R2, Backblaze B2, or any S3-compatible store), connect it **before the first publish**; stored updates are not moved afterwards:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
export OTAFLOW_BUCKET_ACCESS_KEY_ID=...
|
|
65
|
+
export OTAFLOW_BUCKET_SECRET=... # or pipe it in with --secret-stdin
|
|
66
|
+
otaflow storage connect --provider r2 --endpoint https://<account>.r2.cloudflarestorage.com --bucket my-ota --region auto
|
|
67
|
+
otaflow storage check
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Otaflow writes, reads and deletes a test object to check the key. Give the key only that bucket (or one `--prefix`) with read, write and delete. The key is stored encrypted and is never shown again. Devices download from a signed link, or from `--public-url` when the bucket is public or behind a CDN.
|
|
71
|
+
|
|
59
72
|
## In CI
|
|
60
73
|
|
|
61
74
|
```bash
|
|
@@ -74,13 +87,17 @@ A key can publish to preview and ask for a promotion; it can never approve one.
|
|
|
74
87
|
| `login`, `whoami`, `logout` | Sign in through the browser, see who you are, forget the login |
|
|
75
88
|
| `apps list`, `apps create` | List and create apps |
|
|
76
89
|
| `init` | Link this folder to an app |
|
|
77
|
-
| `keys init`, `keys register`, `keys list`, `keys public`, `keys revoke` | The code-signing key |
|
|
90
|
+
| `keys init`, `keys register`, `keys list`, `keys path`, `keys public`, `keys revoke` | The code-signing key (`keys path` says where the private key is, for the backup) |
|
|
78
91
|
| `apikey create`, `apikey list`, `apikey delete` | CI keys, scoped to an app and some actions |
|
|
79
|
-
| `publish` | Export, sign and publish to a channel |
|
|
92
|
+
| `publish` | Export, sign and publish to a channel (`--platform ios` or `android`) |
|
|
80
93
|
| `promote`, `promotions list/approve/reject/cancel` | Move preview to production; decide requests |
|
|
81
94
|
| `rollback` | `--previous`, `--to <id>`, `--embedded`, `--prepared` |
|
|
82
95
|
| `pause`, `resume` | The brake on a channel |
|
|
83
96
|
| `list` | Channel status |
|
|
97
|
+
| `storage connect`, `status`, `check`, `disconnect` | Keep an app's updates in your own S3-compatible bucket (before the first publish) |
|
|
98
|
+
| `members list`, `invite`, `role`, `access`, `remove` | The account's people (owner) |
|
|
99
|
+
| `log` | The activity log, with `--action`, `--actor`, `--only-app` filters |
|
|
100
|
+
| `doctor` | Check this project's setup and say what to fix |
|
|
84
101
|
|
|
85
102
|
Every command takes `--json` for machine-readable output and `--api-url` (or `OTAFLOW_API_URL`) to point at another Otaflow address.
|
|
86
103
|
|