Archived
Offer "quit and update" in the footer, check for updates on every start
The update check ran at most once a day and only printed a line after the TUI exited. Now the registry is asked on every start (in the background, 3 s timeout, no cache) and the result reaches the TUI as a message. With a newer release, the footer shows `q quit and update to vX` right of help and quit, on a highlighted background (Theme.Highlight). `q` quits and `main` installs the release once the terminal is restored, sharing the code of `submarine update`; plain quit moves to `Q`, ctrl+c never updates. Drop LatestCached and CheckInterval. Add D27 and F58. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -221,10 +221,12 @@ No CI runner: releases are built and published from a developer machine.
|
||||
`VERSION`, downloads the asset for the running platform, verifies the
|
||||
checksum and atomically replaces the real executable (symlinks resolved,
|
||||
so `sub` works too). `SUBMARINE_UPDATE_URL` overrides the registry.
|
||||
- After the TUI exits, a one-line notice is printed if a newer release
|
||||
exists. The check runs in the background at startup, at most once a day
|
||||
(cached in the user cache dir) and is off for dev builds,
|
||||
`--mock` and `SUBMARINE_NO_UPDATE_CHECK=1`.
|
||||
- On every start the TUI looks for a newer release in the background (3 s
|
||||
timeout, no cache, no blocking). `main` passes `tui.WithUpdateCheck` and
|
||||
the TUI gets the result as a message; the footer then offers `q quit and
|
||||
update to vX`. That key quits, and `main` installs the release once the
|
||||
terminal is restored (the same code as `submarine update`). The check is off
|
||||
for dev builds, `--mock` and `SUBMARINE_NO_UPDATE_CHECK=1`.
|
||||
|
||||
## Testing
|
||||
|
||||
|
||||
+19
-1
@@ -200,7 +200,8 @@ package so versions stay clean.
|
||||
**Consequences.** Integrity is a sha256 from the same host: it catches
|
||||
corrupt or partial downloads, not a compromised registry (no signatures).
|
||||
The update check is a deliberate, outside-the-provider network use: only
|
||||
on `update` and a once-a-day background check that can be disabled.
|
||||
on `update` and a background check at startup that can be disabled (it
|
||||
was once a day; see D27).
|
||||
|
||||
## Copy path with `c` via OSC 52
|
||||
|
||||
@@ -481,3 +482,20 @@ and the name is what people know. Long names are cut at 16 columns, so the
|
||||
label column cannot grow without bound. In a label every role word has its
|
||||
own style, and `you` is bold in the default color: it was lost between the
|
||||
muted words, and it is the one the user looks for.
|
||||
|
||||
## D27 — Update check on every start, offered as "quit and update"
|
||||
|
||||
**Decision.** The registry is asked on every start, in the background, with
|
||||
no cache. A newer release shows up in the footer as `q quit and update to
|
||||
vX`, right of help and quit, on a highlighted background (black on cyan).
|
||||
While it is shown, `q` quits and updates, and plain quit is `Q`. `ctrl+c`
|
||||
always quits without updating. The update runs after the TUI has exited.
|
||||
**Rationale.** A once-a-day check with a notice printed after exit was
|
||||
easy to miss. The hint is only useful where the user is looking, and the
|
||||
key they use to leave is the natural place. Running the install after the
|
||||
TUI exits keeps the terminal clean and reuses `submarine update`'s code.
|
||||
**Consequences.** Every start makes one small request to the registry (3 s
|
||||
timeout, failures are silent), which supersedes the once-a-day rule of D21.
|
||||
N1 still holds: the TUI never waits for it. `q` changes meaning while an
|
||||
update is available, so muscle memory that exits with `q` now updates; the
|
||||
bar says so. Typing `q` in the filter or a popup is unchanged.
|
||||
|
||||
@@ -164,6 +164,12 @@ submarine [dir] # the repository containing dir (default: current directory)
|
||||
submarine --mock # built-in mock data
|
||||
```
|
||||
|
||||
- **F58** On every start the tool looks for a newer release in the
|
||||
background (never blocking, silent on failure; off for dev builds,
|
||||
`--mock` and `SUBMARINE_NO_UPDATE_CHECK=1`). If there is one, the footer
|
||||
shows `q quit and update to vX` right of help and quit, highlighted; `q`
|
||||
then quits and installs the release, and plain quit is `Q`.
|
||||
|
||||
## Non-functional requirements
|
||||
|
||||
- **N1** Startup must not block on the network. The tool shows the local
|
||||
|
||||
+8
-3
@@ -42,7 +42,10 @@
|
||||
Keys come in three groups (`keyMap.Navigation`, `.Submodule`, `.Global`):
|
||||
|
||||
- **Navigation** (move, fold, toggle): left in the footer.
|
||||
- **Global** (`?`, `q`): right-aligned in the footer, always kept.
|
||||
- **Global** (`?`, `q`): right-aligned in the footer, always kept. If a newer
|
||||
release exists, `q quit and update to vX` follows them as the right-most
|
||||
item, on a highlighted background (`Theme.Highlight`: black on Primary), and
|
||||
plain quit is `Q` (see D27).
|
||||
- **Submodule** (act on the selected one, e.g. `c`): a palette on the last
|
||||
line of the detail pane. It is left out if the pane is shorter than 12
|
||||
lines. Whenever the palette isn't shown (pane hidden or too short), these
|
||||
@@ -250,6 +253,7 @@ colors in components.
|
||||
| Bar | adaptive 254 (light) / 235 (dark) | header background |
|
||||
| Selected | adaptive 253 (light) / 237 (dark) | selected row background |
|
||||
| Backdrop | adaptive 252 (light) / 238 (dark) | the screen behind a popup |
|
||||
| Highlight | ANSI `0` black, bold, on Primary | the `quit and update` hint in the footer |
|
||||
|
||||
- Background shades have no ANSI-16 equivalent, so they use `AdaptiveColor`.
|
||||
The background is detected once in `main` before Bubble Tea starts.
|
||||
@@ -283,7 +287,7 @@ colors in components.
|
||||
| `home` / `g`, `end` / `G` | Header (superproject) / last submodule |
|
||||
| `pgup`, `pgdn` | Move by one screen |
|
||||
| `?` | Toggle full help |
|
||||
| `q`, `ctrl+c` | Quit |
|
||||
| `q`, `ctrl+c` | Quit. With a newer release: `q` quits and updates, `Q` and `ctrl+c` quit |
|
||||
| `f` | Fetch all repositories (does nothing while a fetch runs) |
|
||||
| `r` | Reload everything (e.g. after editing files) |
|
||||
| `c` | Copy the absolute directory of the selected submodule to the clipboard (OSC 52, so it also works over SSH; needs terminal support, in tmux `set -g set-clipboard on`). The footer confirms with `copied <path>`. Without a local provider (mock) the path relative to the superproject is copied |
|
||||
@@ -413,7 +417,8 @@ where the palette can't be shown, see [Key bar and palette](#key-bar-and-palette
|
||||
| `/` | Filter | Global | Help |
|
||||
| `!` | Problems only (toggle) | Global | Help |
|
||||
| `?` | Toggle full help | Global | Bar, Help |
|
||||
| `q`, `ctrl+c` | Quit | Global | Bar, Help |
|
||||
| `q`, `ctrl+c` | Quit (`Q`, `ctrl+c` while an update is offered) | Global | Bar, Help |
|
||||
| `q` | Quit and update to the newer release (only if there is one) | Global | Bar (highlighted), Help |
|
||||
|
||||
### Mouse
|
||||
|
||||
|
||||
Reference in New Issue
Block a user