.gitbay/wiki/Parity.org

  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. Nothing is held back from a surface any more (#234): the
 19registry has no flag for it, and what a caller may do is the account's
 20rights narrowed by the scope of the key or token it arrived with,
 21decided in one place. A =no= in the web or ios column is a page nobody
 22has built yet, not a refusal.
 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| close in favour of another | yes | yes | yes |
 45| create                 | yes | yes | yes |
 46| draft, ready           | yes | yes | yes |
 47| search title and body  | yes | yes | yes |
 48| create from a fork     | yes | yes | yes |
 49| retarget               | yes | yes | yes |
 50| milestone              | yes | yes | yes |
 51| labels                 | yes | yes | yes |
 52| filter by label        | yes | yes | yes |
 53| request a review       | yes | yes | yes |
 54| choose body markup     | yes | yes | yes |
 55| preview body markup    | n/a | yes | no  |
 56| stacked merge requests | yes | yes | yes |
 57| revisions              | yes | yes | yes |
 58| range-diff             | yes | yes | yes |
 59| merge gates            | yes | yes | yes |
 60
 61Reviews and checks carry the time they last said something, and a
 62=ci/<job>= check carries how long its build ran, so a merge request
 63reads without opening the build. Statuses posted through =status set=
 64have no build and report only the time. A merged or closed merge
 65request names who resolved it and when; a row without that stamp — a
 66=migrate= import, or one merged before krz/gitbay!137 with no
 67=mr.merged= event to backfill from — says neither rather than
 68inventing a time.
 69
 70A merge request whose target is another open merge request's source
 71branch is stacked on it: =mr show= and the page say so both ways, and
 72when the lower one merges, everything stacked on it is retargeted onto
 73what it merged into with its reviews kept. A squash or rebase merge is
 74refused while anything is stacked on the merge request, since it would
 75rewrite the commits the stack builds on. All three surfaces show the
 76stack both ways.
 77
 78A draft merge request is open but not asking: it does not merge, and it
 79does not appear in anyone's review queue. Draft is a flag rather than a
 80fifth state, so every =state = 'open'= rule still means what it did.
 81=mr revisions= lists the heads a merge request has had; the web page
 82lists them beside the reviews they staled, and the iOS client has a
 83Revisions section. =mr range-diff= compares two heads: the iOS client shows it from a
 84revision to the one before, as text; the web renders the same view, with
 85a "compare to previous" link on each revision after the first. Batched
 86review — draft diff comments held with =mr comment --pending= and sent
 87together with =--comment=/=--discard= or a verdict — is built and the
 88web uses it: composing review comments before publishing them is the same
 89round trip as the CLI's =--pending= flag.
 90
 91=mr review request --add <user>= asks a *particular* person, who then
 92carries the merge request in their queue and is notified; =--remove=
 93withdraws the ask. Without one the queue is computed from involvement —
 94what you own, are granted, or reach through an org or team — so a
 95collaborator with write access who has not touched a thread hears
 96nothing until they do (krz/gitbay#145).
 97
 98Creating from a fork works anywhere the source can be typed as
 99=owner/name:branch=. The web's source picker offers the branches of
100every fork the viewer can push to in that form, and the repository
101header has the fork control, so the whole path — fork, edit a file,
102propose — runs in a browser. Retargeting moves an open
103merge request onto another branch of the same repository and stales the
104reviews, since an approval was of the diff against the old branch.
105
106* Issues
107
108| capability          | cli | web | ios |
109|---------------------+-----+-----+-----|
110| read, list, filter  | yes | yes | yes |
111| filter by label, assignee, author, milestone | yes | yes | yes |
112| search title and body | yes | yes | yes |
113| create              | yes | yes | yes |
114| comment             | yes | yes | yes |
115| edit title and body | yes | yes | yes |
116| close and reopen    | yes | yes | yes |
117| labels, assignees   | yes | yes | yes |
118| milestone           | yes | yes | yes |
119| milestone list      | yes | yes | yes |
120| labels: list, colour | yes | yes | yes |
121| choose body markup  | yes | yes | yes |
122| preview body markup | n/a | yes | no  |
123| issue templates     | yes | yes | yes |
124| milestone create, close, reopen | yes | no | yes |
125| org labels: set, list, remove | yes | list | yes |
126| org milestones: create, list, close, reopen | yes | list | yes |
127| closes across repositories | yes | yes | yes |
128
129Labels are created on the fly by =issue label --add= and =mr label
130--add=, and managed by =label list=, =label set <label> --color rrggbb=
131and =label remove=, which takes the label off every issue and merge
132request. One set serves both. The web paints the stored colour on every
133chip and derives one from the name when none is set. The set itself is
134at =/<owner>/<repo>/labels=, linked from the issue list: create,
135recolour and remove, dispatching the same commands.
136
137Org labels and milestones are managed on the CLI, the API and the iOS
138client's org screen; =/<org>/-/labels= and =/<org>/-/milestones= show
139them on the web. The repository
140label page's form exists for colour alone, and three org forms nobody
141asked for were not worth their handlers.
142
143Issue, MR and release bodies, and their comments, carry the markup they
144were written in — =--format md|org= on create, comment and edit, stored
145alongside the text so changing a preference later cannot reinterpret
146prose that already exists. Every surface *renders* the stored format, and
147every surface now offers the choice: the web's create forms, and the iOS
148composer on create, edit and comment. An edit starts on the format its
149body was stored in, since starting elsewhere would silently reinterpret
150it on the next save. Diff-line comments have no format column and are
151always markdown.
152
153Every web form that takes markup has a Preview button beside its own
154submit: issue and merge request create, their edit and comment boxes,
155release create and edit, and the file editor on
156a path the forge renders. It posts to the form's own action, which
157renders the draft and hands the page back without writing, so what you
158see is the rendering the thread will show, autolinks included. It is a
159round trip rather than a live preview because the instance serves no
160JavaScript, the same way the blob page's rendered/source toggle works.
161The row is =n/a= on the CLI: a terminal has no form to preview, and
162=issue show= already renders. Diff-line comments are left out — they
163sit inside the diff, where a page-level preview has nowhere to go.
164
165The iOS client resolves no autolinks: =#N= and =owner/name#N= render as
166text in its threads, so a preview there will show the app's rendering
167rather than the one the web page shows.
168
169* Repositories
170
171| capability                  | cli | web | ios |
172|-----------------------------+-----+-----+-----|
173| browse files                | yes | yes | yes |
174| read a file                 | yes | yes | yes |
175| render a README             | yes | yes | yes |
176| commit log                  | yes | yes | yes |
177| commit log at a ref         | yes | yes | yes |
178| one commit with its patch   | yes | yes | yes |
179| blame                       | yes | yes | yes |
180| search file contents        | yes | yes | yes |
181| compare two refs            | yes | yes | yes |
182| branches and tags           | yes | yes | yes |
183| wiki (read)                 | yes | yes | yes |
184| download an archive         | yes | yes | n/a |
185| edit a file                 | yes | yes | yes |
186| preview an edited markup file | n/a | yes | no  |
187| create                      | yes | yes | yes |
188| fork                        | yes | yes | yes |
189| pin                         | yes | yes | yes |
190| bookmark                    | yes | yes | yes |
191| bookmark list               | yes | yes | yes |
192| bookmarks on your profile   | n/a | yes | no  |
193| watch, unwatch              | yes | yes | yes |
194| mute                        | yes | yes | yes |
195| settings, protection        | yes | yes | yes |
196| default branch              | yes | yes | yes |
197| merge requests only         | yes | yes | yes |
198| protected tags              | yes | yes | yes |
199| require codeowners          | yes | yes | yes |
200| require contexts            | yes | yes | no  |
201| access grants               | yes | no  | yes |
202| effective access            | yes | no  | yes |
203| webhooks                    | yes | no  | yes |
204| runners attach, list, detach | yes | yes | n/a |
205| import from a remote        | yes | no  | yes |
206| topics, website             | yes | yes | yes |
207| visibility                  | yes | yes | yes |
208| archive (read-only flag)    | yes | yes | yes |
209| release list, show          | yes | yes | yes |
210| atom feeds                  | n/a | yes | n/a |
211| release create, edit        | yes | yes | yes |
212| preview release notes       | n/a | yes | no  |
213| build list                  | yes | yes | yes |
214| build list paging (limit, cursor) | yes | yes | no  |
215| build row names its commit  | yes | yes | no  |
216| build list filters (ref, status, job) | yes | yes | yes |
217| build show (one build)      | yes | yes | yes |
218| build log                   | yes | yes | yes |
219| build log follow (until it ends) | yes | yes | no  |
220| build failed step, duration | yes | yes | no  |
221| build log one step          | yes | yes | no  |
222| build log tail              | yes | no  | no  |
223| build jobs                  | yes | yes | yes |
224| build trigger               | yes | yes | yes |
225| build cancel                | yes | yes | yes |
226| job image (ci.yml)          | yes | n/a | n/a |
227| dependency checks on/off    | yes | yes | yes |
228| dependency status           | yes | yes | yes |
229| delete, transfer            | yes | no  | no  |
230| rename                      | yes | no  | yes |
231| release delete              | yes | yes | yes |
232| release asset add           | yes | no  | n/a |
233| release asset remove        | yes | no  | yes |
234| snippet create, edit, delete  | yes | yes | yes |
235| snippet show, list            | yes | yes | yes |
236| snippet file set, get, remove | yes | yes | yes |
237
238No row is web-only any more. Blame, file editing, log at a ref,
239archive, the public listing and the wiki were all in that state — a
240handler reading git or the store directly instead of dispatching a
241command — until krz/gitbay!99, !101 and !102 gave them commands.
242
243=build cancel= withdraws a queued build, or ends a running one: the
244server closes the runner's log session and the runner kills the step
245within a couple of seconds. Cancelling a duplicate of a commit that
246already passed the job puts that result back on the commit. The build
247page carries the button while a build is still cancellable.
248
249A pin and a bookmark are different things and are stored separately. A
250pin is private quick access to what you are working on, and drives the
251rail; a bookmark is public, says a repository is worth coming back to,
252and its count is the only popularity signal on the instance. Bookmarking
253needs read access only — it is something you do to someone else's
254repository — and a repository bookmarked while public and since made
255private drops out of the listing rather than leaking that it exists
256(krz/gitbay#146).
257
258The web's watch and pin controls dispatch =repo pin=/=repo unpin= and
259=repo watch=/=repo mute=/=repo unwatch=, the same commands the CLI runs
260(krz/gitbay#261). The single watch button cycles default, watching and
261muted.
262
263Dependency checks are off until a repository's admin turns them on: the
264check tells a public registry what the repository depends on. =repo deps
265status= lists what is behind; the repository's settings page renders the
266same report under the toggle — last check, last error, the tracking
267issue, and the rows. The issue the worker opens, rewrites and closes is
268still the copy every other surface reads.
269
270The wiki row covers reading. A wiki lives at =.gitbay/wiki/= on the
271default branch, so editing one is editing a file in the repository —
272a push, or =repo commit-file= — and there is no wiki-specific edit row
273to have parity on. The web editor reaches it on any repository that
274permits server-authored commits; one requiring verified signatures
275does not, because the server signs nothing on a user's behalf, so
276those wikis are push-only.
277
278=n/a= marks a capability deliberately absent from a surface rather than
279missing from it. Archive download is =n/a= on iOS: the read API carries
280a command's stdout as a JSON string, so a gzip stream cannot survive it,
281and the app has nowhere useful to put a tarball — the brief rules out
282local git, so there is no clone, checkout or build to feed. The web's
283route stays the way to get one. =release asset add= is =n/a= on iOS for
284the same reason from the other direction: the file arrives on stdin,
285which the API carries as a JSON string. Attaching a runner is =n/a= on
286iOS for a plainer reason: the key is generated by =gitbay-runner init=
287on the machine that will run builds, and that machine's terminal (the
288command =init= prints) or the settings page is where the paste happens.
289A phone has neither the key nor the runner.
290
291A README or wiki page's org renders per surface: the web through
292go-org, the iOS client through the shared OrgSwift package
293(=krz/org-swift=). OrgSwift is held to orgo's output by the
294=krz/org-conformance= corpus — golden renderings from orgo, itself
295diffed against Emacs =ox-html= — so constructs the iOS client used to
296approximate (tables, footnotes, timestamps, heading tags, nested lists)
297now render the way the reference does. go-org is not yet on the corpus.
298
299* Discovery
300
301| capability                       | cli | web | ios |
302|----------------------------------+-----+-----+-----|
303| search repositories              | yes | yes | yes |
304| search issues and merge requests | yes | yes | yes |
305| browse all public repositories   | yes | yes | yes |
306| profile page                     | yes | yes | yes |
307| profile sections as tabs         | n/a | yes | n/a |
308| profile about and links          | yes | yes | yes |
309| profile about as a file          | yes | yes | yes |
310| activity feed                    | yes | yes | yes |
311| command reference                | yes | no  | n/a |
312
313=explore= is the listing without a query; =repo search= is the one with.
314=search= is both plus the title and body of every issue and merge
315request the caller can read, over FTS5; the web serves it at =/search=
316with a field in the rail, and an anonymous visitor gets the public rows
317from the same query. =issue list --search= and =mr list --search= narrow
318one repository. What someone types is quoted term by term, so an FTS5
319operator — =c++=, =AND=, a lone quote — is a word to match and never a
320syntax error. =repo grep= remains the per-repository file-contents
321search.
322
323The about text is =profile/README.{md,org,markdown}= on the default
324branch of =<owner>/.gitbay=, resolved in that order, so the extension
325picks the renderer rather than a stored format. =profile show= reports
326it as =about=, =about_format= and =about_path=. It reads with the
327repository's own access, so a private =.gitbay= is a profile with no
328about text to anyone but its owner and the admins. A repository whose
329name starts with a dot stays out of =explore= and off the profile's
330repository list. On the web a profile is tabs: =/<owner>= is About —
331the text, the year of squares and a log of the newest thirty events —
332then =/<owner>/-/repositories=, =/<owner>/-/bookmarks=,
333=/<owner>/-/snippets=, and =/<owner>/-/people= for an organization's
334members and teams. A tab nobody may open is not offered and its URL is
335a 404: bookmarks are the viewer's own, only a user has snippets, and
336people is the org admin panel. The log counts what the graph over it
337counts — a user's own events, an organization's repositories' — on
338public repositories only; =activity.atom= is the feed that goes back
339further. The CLI's =profile show= is unchanged and still returns all of
340it at once. The iOS client decodes and renders both formats,
341through the same OrgSwift path a README takes.
342
343=help= lists the command registry. Bare it is an index, one line per
344command, sorted. With a prefix (=help mr=) it adds each command's
345argument syntax, which is the only place flags are written down;
346=gitbay <cmd> --help= asks the server for the same thing, and =--json=
347returns ={path, summary, usage}=. No web page renders it, and a native
348client has no use for one (krz/gitbay#57).
349
350* Accounts
351
352| capability                  | cli | web | ios |
353|-----------------------------+-----+-----+-----|
354| SSH keys: list, add, remove | yes | yes | yes |
355| SSH key label               | yes | yes | yes |
356| SSH key expiry and last use | yes | no  | no  |
357| PGP keys: list, add, remove | yes | yes | yes |
358| email add and verify        | yes | yes | yes |
359| email list, remove, primary | yes | yes | yes |
360| dashboard aggregate         | yes | yes | yes |
361| notification inbox          | yes | yes | yes |
362| activity mail on, off       | yes | yes | yes |
363| watch writable repos        | yes | yes | yes |
364| push device add             | yes | yes | yes |
365| push device list            | yes | yes | yes |
366| push device remove          | yes | yes | yes |
367| activity push on, off       | yes | yes | yes |
368| web colour scheme           | yes | yes | n/a |
369| API token mint              | yes | yes | no  |
370| API token list, revoke      | yes | yes | no  |
371| API token revoke with what it created | yes | no  | no  |
372| account export bundle       | yes | yes | n/a |
373| profile set                 | yes | yes | yes |
374| write the profile about     | yes | yes | yes |
375| request a login link        | n/a | yes | n/a |
376| account import bundle       | yes | no  | n/a |
377
378Notifications land in an inbox row per recipient whether or not the
379instance sends mail, and mail is the second half when SMTP is
380configured. =notifications list= reads it, unread by default;
381=notifications read <id>... | --all= clears it; the dashboard and the
382web rail carry the unread count. =repo watch= adds you to a
383repository's notifications, =repo mute= silences it, and =repo unwatch=
384returns you to the default from either — told about work you are part
385of, nothing more. =notifications settings watch on= widens that default
386to every repository you can write to, without a row per repository. A
387mute wins over owning the repository, having written the thread, or the
388preference.
389
390Push is the third leg beside inbox and mail, delivered to Apple devices
391an account has registered. =notifications device add= runs on every
392surface like every other command, but no web page offers a form for
393it, because only the iOS app can produce an APNs device token — a
394browser has no way to ask Apple for one. =device list= and =device
395remove= have no such limit and are yes on the web like the rest.
396
397A login link is requested from the login page by username or verified
398address, and arrives by mail: it works once and expires in fifteen
399minutes. The row is =n/a= for the CLI because a terminal with a
400registered key runs =web login=, which mints a link directly and needs
401no mail. It exists because an account with no SSH key had no way into
402the web at all (krz/gitbay#155). The page offers the form only when the
403instance has SMTP configured; there is no separate switch. The response
404never says whether the account exists. It is =n/a= on iOS for the same
405reason it is on the CLI, from the other end: the app authenticates with
406a bearer token pasted at sign-in, so a one-time link into the web
407unlocks nothing it can use.
408
409The account export bundle is =n/a= on iOS on the archive-download
410argument above — a JSON bundle has nowhere useful to land on a phone,
411and the web route stays the way to get one.
412
413=profile set= carries description, website and links; the JSON API runs
414it like any other write. The account settings page has the form, and so
415does the iOS client: =--link= replaces the whole set rather than
416appending, so a client sends every link it keeps on every save, and
417=--link ''= is how they are cleared.
418
419The about text is not among those flags. It is a file, written by a push
420or =repo commit-file= like any other file, which is why writing it is
421yes on every surface: anything that can commit a file can write it. The
422settings page points at the file and offers to create =<owner>/.gitbay=
423when there is none.
424
425* Administration
426
427| capability                      | cli | web | ios |
428|---------------------------------+-----+-----+-----|
429| account list, filter by state   | yes | yes | no  |
430| account show                    | yes | no  | no  |
431| promote, demote                 | yes | yes | no  |
432| disable, enable                 | yes | yes | no  |
433| account create, delete          | yes | no  | no  |
434| invite                          | yes | no  | no  |
435| worker queues                   | yes | yes | no  |
436| runners                         | yes | no  | no  |
437| repository list, archive, visibility | yes | no | no |
438| audit log                       | yes | no  | no  |
439| instance statistics             | yes | no  | no  |
440
441=/admin/users= carries the account list with the command's state
442filter and cursor, and promote, demote, disable and enable per row;
443demote and disable ask for the username to be typed. The rest is a
444page nobody has built yet rather than a refusal — see below. Account
445creation and deletion stay on the command line on purpose: one takes a
446key, the other cannot be undone.
447
448* Organizations
449
450| capability                | cli | web | ios |
451|---------------------------+-----+-----+-----|
452| read members and teams    | yes | yes | yes |
453| members add, remove, role | yes | yes | yes |
454| teams create, delete      | yes | yes | yes |
455| team members              | yes | yes | yes |
456| team repo grants          | yes | yes | yes |
457| create, rename            | yes | yes | yes |
458| delete                    | yes | n/a | n/a |
459| profile                   | yes | no  | yes |
460
461* Pagination
462
463=issue list=, =mr list=, =repo list=, =feed= and =build list= take
464=--limit <n>= and =--cursor <c>=. Cursors are opaque; each page carries
465the next one. Without the flags a list stays as it was, so existing
466scripts are unchanged — for =build list= that means the newest fifty
467matching builds, which is what the cursor now reaches past. The web
468pages the issue and merge request lists at fifty and the builds list at
469thirty with the same cursors; iOS pages with them too.
470
471* CLI only, for now
472
473Build secrets, mirror configuration and tokens, custom domain claims,
474web session listing and revocation, deploy keys, and instance
475administration have no page yet. Until #234 these were
476refused outright on the other surfaces; the refusal is gone, so each is
477now a page waiting to be built rather than a rule. A credential still
478travels on stdin wherever it is set, since argv is world-readable in
479/proc and the audit log keeps flag values.
480
481Deleting or transferring a repository stays CLI-only on purpose, as
482does deleting an organization and pruning merge request heads (=admin
483mr prune=): each removes or moves what clone URLs point at, and wants a
484typed command rather than a button. Renaming is the exception: the iOS
485client offers it, and the web has no page yet.
486
487=n/a= means a surface cannot usefully carry the capability at all —
488see the archive note above.