.gitbay/wiki/Parity.org
379 lines · 19012 bytes
1#+title: Parity
2
3Which surface can do what. The CLI is meant to be the complete
4interface: every capability exists over SSH, and the other surfaces
5dispatch the same control commands rather than reimplementing them, so
6they cannot drift. This page is updated in the merge request that
7changes a row.
8
9Three surfaces now: the CLI over SSH, the web, and the iOS client
10(krz/gitbay-ios). A =no= in the cli column is a defect, not a
11preference — it means some surface reached around the registry and
12stranded a capability where only it can reach.
13
14* Rule
15
16A capability lands over SSH first. If it belongs to the
17triage/review/respond loop, it lands on the web in the same merge
18request. Anything whose input is a credential — secrets, mirror
19tokens, API tokens — stays SSH-only by design: the web dispatcher
20refuses =SSHOnly= commands outright. Session minting is not one of
21them: what a browser submits to ask for a login link is a username or
22an address, and the credential it gets back travels by mail.
23
24Rows are one page or one action each. Grouped rows hide gaps, twice
25now: "browse, log, blame, search" read as covered while blame had no
26command at all, and "build list, log" read as covered while the job
27list a trigger can name had none (krz/gitbay#50), leaving the picker
28browser-only and the iOS build screen unable to say more than the log.
29
30* Merge requests
31
32| capability | cli | web | ios |
33|------------------------+-----+-----+-----|
34| read, diff, commits | yes | yes | yes |
35| review and check times | yes | yes | yes |
36| who resolved it, when | yes | yes | yes |
37| comment | yes | yes | yes |
38| edit title and body | yes | yes | yes |
39| review (approve etc.) | yes | yes | yes |
40| resolve a thread | yes | yes | yes |
41| comment on a diff line | yes | yes | yes |
42| merge (all strategies) | yes | yes | yes |
43| close | yes | yes | yes |
44| create | yes | yes | yes |
45| draft, ready | yes | yes | yes |
46| search title and body | yes | yes | yes |
47| create from a fork | yes | yes | yes |
48| retarget | yes | yes | yes |
49| milestone | yes | yes | yes |
50| request a review | yes | yes | yes |
51| choose body markup | yes | yes | yes |
52| stacked merge requests | yes | yes | yes |
53| revisions | yes | yes | yes |
54| range-diff | yes | no | yes |
55| merge gates | yes | yes | yes |
56
57Reviews and checks carry the time they last said something, and a
58=ci/<job>= check carries how long its build ran, so a merge request
59reads without opening the build. Statuses posted through =status set=
60have no build and report only the time. A merged or closed merge
61request names who resolved it and when; a row without that stamp — a
62=migrate= import, or one merged before krz/gitbay!137 with no
63=mr.merged= event to backfill from — says neither rather than
64inventing a time.
65
66A merge request whose target is another open merge request's source
67branch is stacked on it: =mr show= and the page say so both ways, and
68when the lower one merges, everything stacked on it is retargeted onto
69what it merged into with its reviews kept. A squash or rebase merge is
70refused while anything is stacked on the merge request, since it would
71rewrite the commits the stack builds on. All three surfaces show the
72stack both ways.
73
74A draft merge request is open but not asking: it does not merge, and it
75does not appear in anyone's review queue. Draft is a flag rather than a
76fifth state, so every =state = 'open'= rule still means what it did.
77=mr revisions= lists the heads a merge request has had; the web page
78lists them beside the reviews they staled, and the iOS client has a
79Revisions section. =mr range-diff= compares two heads: the iOS client
80shows it from a revision to the one before, as text; the web has no
81view. Batched review is not built.
82
83=mr review request --add <user>= asks a *particular* person, who then
84carries the merge request in their queue and is notified; =--remove=
85withdraws the ask. Without one the queue is computed from involvement —
86what you own, are granted, or reach through an org or team — so a
87collaborator with write access who has not touched a thread hears
88nothing until they do (krz/gitbay#145).
89
90Creating from a fork works anywhere the source can be typed as
91=owner/name:branch=. The web's source picker offers the branches of
92every fork the viewer can push to in that form, and the repository
93header has the fork control, so the whole path — fork, edit a file,
94propose — runs in a browser. Retargeting moves an open
95merge request onto another branch of the same repository and stales the
96reviews, since an approval was of the diff against the old branch.
97
98* Issues
99
100| capability | cli | web | ios |
101|---------------------+-----+-----+-----|
102| read, list, filter | yes | yes | yes |
103| filter by label, assignee, author, milestone | yes | yes | yes |
104| search title and body | yes | yes | yes |
105| create | yes | yes | yes |
106| comment | yes | yes | yes |
107| edit title and body | yes | yes | yes |
108| close and reopen | yes | yes | yes |
109| labels, assignees | yes | yes | yes |
110| milestone | yes | yes | yes |
111| milestone list | yes | yes | yes |
112| labels: list, colour | yes | yes | yes |
113| choose body markup | yes | yes | yes |
114| issue templates | yes | yes | yes |
115| milestone create, close, reopen | yes | no | yes |
116| org labels: set, list, remove | yes | list | no |
117| org milestones: create, list, close, reopen | yes | list | no |
118| closes across repositories | yes | yes | yes |
119
120Labels are created on the fly by =issue label --add= and managed by
121=label list=, =label set <label> --color rrggbb= and =label remove=,
122which takes the label off every issue. The web paints the stored colour
123on every chip and derives one from the name when none is set. The set
124itself is at =/<owner>/<repo>/labels=, linked from the issue list:
125create, recolour and remove, dispatching the same commands.
126
127Org labels and milestones are managed on the CLI and API only;
128=/<org>/-/labels= and =/<org>/-/milestones= show them. The repository
129label page's form exists for colour alone, and three org forms nobody
130asked for were not worth their handlers.
131
132Issue, MR and release bodies, and their comments, carry the markup they
133were written in — =--format md|org= on create, comment and edit, stored
134alongside the text so changing a preference later cannot reinterpret
135prose that already exists. Every surface *renders* the stored format, and
136every surface now offers the choice: the web's create forms, and the iOS
137composer on create, edit and comment. An edit starts on the format its
138body was stored in, since starting elsewhere would silently reinterpret
139it on the next save. Diff-line comments have no format column and are
140always markdown.
141
142* Repositories
143
144| capability | cli | web | ios |
145|-----------------------------+-----+-----+-----|
146| browse files | yes | yes | yes |
147| read a file | yes | yes | yes |
148| commit log | yes | yes | yes |
149| commit log at a ref | yes | yes | yes |
150| one commit with its patch | yes | yes | yes |
151| blame | yes | yes | yes |
152| search file contents | yes | yes | yes |
153| compare two refs | yes | yes | yes |
154| branches and tags | yes | yes | yes |
155| wiki (read) | yes | yes | yes |
156| download an archive | yes | yes | n/a |
157| edit a file | yes | yes | yes |
158| create | yes | yes | yes |
159| fork | yes | yes | yes |
160| pin | yes | yes | yes |
161| bookmark | yes | yes | yes |
162| bookmark list | yes | yes | yes |
163| watch, unwatch | yes | yes | yes |
164| mute | yes | no | yes |
165| settings, protection | yes | yes | yes |
166| default branch | yes | yes | yes |
167| merge requests only | yes | yes | yes |
168| protected tags | yes | yes | yes |
169| require codeowners | yes | yes | yes |
170| access grants | yes | no | yes |
171| effective access | yes | no | yes |
172| webhooks | yes | no | yes |
173| runners attach, list, detach | yes | yes | n/a |
174| import from a remote | yes | no | yes |
175| topics, website | yes | yes | yes |
176| visibility | yes | yes | yes |
177| archive (read-only flag) | yes | yes | yes |
178| release list, show | yes | yes | yes |
179| atom feeds | n/a | yes | n/a |
180| release create, edit | yes | yes | yes |
181| build list | yes | yes | yes |
182| build list filters (ref, status, job) | yes | yes | no |
183| build show (one build) | yes | yes | yes |
184| build log | yes | yes | yes |
185| build jobs | yes | yes | yes |
186| build trigger | yes | yes | yes |
187| build cancel | yes | yes | yes |
188| job image (ci.yml) | yes | n/a | n/a |
189| dependency checks on/off | yes | yes | yes |
190| dependency status | yes | yes | yes |
191| delete, transfer | yes | no | no |
192| rename | yes | no | yes |
193| release delete | yes | yes | yes |
194| release asset add | yes | no | n/a |
195| release asset remove | yes | no | yes |
196| snippet create, edit, delete | yes | yes | no |
197| snippet show, list | yes | yes | no |
198| snippet file set, get, remove | yes | yes | no |
199
200No row is web-only any more. Blame, file editing, log at a ref,
201archive, the public listing and the wiki were all in that state — a
202handler reading git or the store directly instead of dispatching a
203command — until krz/gitbay!99, !101 and !102 gave them commands.
204
205=build cancel= withdraws a queued build, or ends a running one: the
206server closes the runner's log session and the runner kills the step
207within a couple of seconds. Cancelling a duplicate of a commit that
208already passed the job puts that result back on the commit. The build
209page carries the button while a build is still cancellable.
210
211A pin and a bookmark are different things and are stored separately. A
212pin is private quick access to what you are working on, and drives the
213rail; a bookmark is public, says a repository is worth coming back to,
214and its count is the only popularity signal on the instance. Bookmarking
215needs read access only — it is something you do to someone else's
216repository — and a repository bookmarked while public and since made
217private drops out of the listing rather than leaking that it exists
218(krz/gitbay#146).
219
220The web's watch and pin controls write the store directly instead of
221dispatching =repo watch= and =repo pin=. That is why the web cannot
222mute: its toggle knows watching and default only.
223
224Dependency checks are off until a repository's admin turns them on: the
225check tells a public registry what the repository depends on. =repo deps
226status= lists what is behind; the repository's settings page renders the
227same report under the toggle — last check, last error, the tracking
228issue, and the rows. The issue the worker opens, rewrites and closes is
229still the copy every other surface reads.
230
231The wiki row covers reading. A wiki lives at =.gitbay/wiki/= on the
232default branch, so editing one is editing a file in the repository —
233a push, or =repo commit-file= — and there is no wiki-specific edit row
234to have parity on. The web editor reaches it on any repository that
235permits server-authored commits; one requiring verified signatures
236does not, because the server signs nothing on a user's behalf, so
237those wikis are push-only.
238
239=n/a= marks a capability deliberately absent from a surface rather than
240missing from it. Archive download is =n/a= on iOS: the read API carries
241a command's stdout as a JSON string, so a gzip stream cannot survive it,
242and the app has nowhere useful to put a tarball — the brief rules out
243local git, so there is no clone, checkout or build to feed. The web's
244route stays the way to get one. =release asset add= is =n/a= on iOS for
245the same reason from the other direction: the file arrives on stdin,
246which the API carries as a JSON string. Attaching a runner is =n/a= on
247iOS for a plainer reason: the key is generated by =gitbay-runner init=
248on the machine that will run builds, and that machine's terminal (the
249command =init= prints) or the settings page is where the paste happens.
250A phone has neither the key nor the runner.
251
252A README or wiki page's org renders per surface: the web through
253go-org, the iOS client through the shared OrgSwift package
254(=krz/org-swift=). OrgSwift is held to orgo's output by the
255=krz/org-conformance= corpus — golden renderings from orgo, itself
256diffed against Emacs =ox-html= — so constructs the iOS client used to
257approximate (tables, footnotes, timestamps, heading tags, nested lists)
258now render the way the reference does. go-org is not yet on the corpus.
259
260* Discovery
261
262| capability | cli | web | ios |
263|----------------------------------+-----+-----+-----|
264| search repositories | yes | yes | yes |
265| search issues and merge requests | yes | yes | yes |
266| browse all public repositories | yes | yes | yes |
267| profile page | yes | yes | yes |
268| profile about and links | yes | yes | yes |
269| activity feed | yes | yes | yes |
270| command reference | yes | no | n/a |
271
272=explore= is the listing without a query; =repo search= is the one with.
273=search= is both plus the title and body of every issue and merge
274request the caller can read, over FTS5; the web serves it at =/search=
275with a field in the rail, and an anonymous visitor gets the public rows
276from the same query. =issue list --search= and =mr list --search= narrow
277one repository. What someone types is quoted term by term, so an FTS5
278operator — =c++=, =AND=, a lone quote — is a word to match and never a
279syntax error. =repo grep= remains the per-repository file-contents
280search.
281
282About text renders as markdown or org-mode per the =about_format= it
283was stored with. The iOS client decodes and renders both,
284through the same OrgSwift path a README takes.
285
286=help= lists the command registry. Bare it is an index, one line per
287command, sorted. With a prefix (=help mr=) it adds each command's
288argument syntax, which is the only place flags are written down;
289=gitbay <cmd> --help= asks the server for the same thing, and =--json=
290returns ={path, summary, usage}=. No web page renders it, and a native
291client has no use for one (krz/gitbay#57).
292
293* Accounts
294
295| capability | cli | web | ios |
296|-----------------------------+-----+-----+-----|
297| SSH keys: list, add, remove | yes | yes | yes |
298| SSH key label | yes | yes | no |
299| PGP keys: list, add, remove | yes | yes | yes |
300| email add and verify | yes | yes | yes |
301| email list, remove, primary | yes | yes | yes |
302| dashboard aggregate | yes | yes | yes |
303| notification inbox | yes | yes | yes |
304| activity mail on, off | yes | yes | yes |
305| watch writable repos | yes | yes | no |
306| API token mint | yes | no | no |
307| account export bundle | yes | yes | n/a |
308| profile set | yes | yes | yes |
309| request a login link | n/a | yes | n/a |
310| account import bundle | yes | no | n/a |
311
312Notifications land in an inbox row per recipient whether or not the
313instance sends mail, and mail is the second half when SMTP is
314configured. =notifications list= reads it, unread by default;
315=notifications read <id>... | --all= clears it; the dashboard and the
316web rail carry the unread count. =repo watch= adds you to a
317repository's notifications, =repo mute= silences it, and =repo unwatch=
318returns you to the default from either — told about work you are part
319of, nothing more. =notifications settings watch on= widens that default
320to every repository you can write to, without a row per repository. A
321mute wins over owning the repository, having written the thread, or the
322preference.
323
324A login link is requested from the login page by username or verified
325address, and arrives by mail: it works once and expires in fifteen
326minutes. The row is =n/a= for the CLI because a terminal with a
327registered key runs =web login=, which mints a link directly and needs
328no mail. It exists because an account with no SSH key had no way into
329the web at all (krz/gitbay#155). The page offers the form only when the
330instance has SMTP configured; there is no separate switch. The response
331never says whether the account exists. It is =n/a= on iOS for the same
332reason it is on the CLI, from the other end: the app authenticates with
333a bearer token pasted at sign-in, so a one-time link into the web
334unlocks nothing it can use.
335
336The account export bundle is =n/a= on iOS on the archive-download
337argument above — a JSON bundle has nowhere useful to land on a phone,
338and the web route stays the way to get one.
339
340=profile set= carries description, website, about and links. It is not
341=SSHOnly= — nothing about a bio is a credential, and the JSON API runs
342it. The account settings page has the form, and so does the iOS client:
343=--link= replaces the whole set rather than appending, so a client sends
344every link it keeps on every save, and =--link ''= is how they are
345cleared.
346
347* Organizations
348
349| capability | cli | web | ios |
350|---------------------------+-----+-----+-----|
351| read members and teams | yes | yes | yes |
352| members add, remove, role | yes | yes | yes |
353| teams create, delete | yes | yes | yes |
354| team members | yes | yes | yes |
355| team repo grants | yes | yes | yes |
356| create, rename | yes | yes | yes |
357| delete | yes | n/a | n/a |
358| profile | yes | no | yes |
359
360* Pagination
361
362=issue list=, =mr list=, =repo list=, and =feed= take =--limit <n>=
363and =--cursor <c>=. Cursors are opaque; each page carries the next
364one. Without the flags a list stays complete, so existing scripts are
365unchanged. The web pages the issue and merge request lists at fifty
366with the same cursors; iOS pages with them too.
367
368* SSH only, by design
369
370Build secrets, mirror configuration and tokens, custom domain claims,
371API token minting, web session listing and revocation, deploy keys,
372account and instance administration. Deleting, transferring or renaming
373a repository is also CLI-only, as is deleting an organization and
374pruning merge request heads (=admin mr prune=): each removes or moves
375what clone URLs point at, and wants a typed command, not a button.
376
377These are the only rows where a =no= is intended. Everywhere else a
378=no= is work outstanding, and =n/a= means a surface cannot usefully
379carry the capability at all — see the archive note above.