.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. 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
117Labels are created on the fly by =issue label --add= and managed by
118=label list=, =label set <label> --color rrggbb= and =label remove=,
119which takes the label off every issue. The web paints the stored colour
120on every chip and derives one from the name when none is set. The set
121itself is at =/<owner>/<repo>/labels=, linked from the issue list:
122create, recolour and remove, dispatching the same commands.
123
124Issue, MR and release bodies, and their comments, carry the markup they
125were written in — =--format md|org= on create, comment and edit, stored
126alongside the text so changing a preference later cannot reinterpret
127prose that already exists. Every surface *renders* the stored format, and
128every surface now offers the choice: the web's create forms, and the iOS
129composer on create, edit and comment. An edit starts on the format its
130body was stored in, since starting elsewhere would silently reinterpret
131it on the next save. Diff-line comments have no format column and are
132always markdown.
133
134* Repositories
135
136| capability                  | cli | web | ios |
137|-----------------------------+-----+-----+-----|
138| browse files                | yes | yes | yes |
139| read a file                 | yes | yes | yes |
140| commit log                  | yes | yes | yes |
141| commit log at a ref         | yes | yes | yes |
142| one commit with its patch   | yes | yes | yes |
143| blame                       | yes | yes | yes |
144| search file contents        | yes | yes | yes |
145| compare two refs            | yes | yes | yes |
146| branches and tags           | yes | yes | yes |
147| wiki (read)                 | yes | yes | yes |
148| download an archive         | yes | yes | n/a |
149| edit a file                 | yes | yes | yes |
150| create                      | yes | yes | yes |
151| fork                        | yes | yes | yes |
152| pin                         | yes | yes | yes |
153| bookmark                    | yes | yes | yes |
154| bookmark list               | yes | yes | yes |
155| watch, unwatch              | yes | yes | yes |
156| mute                        | yes | no  | yes |
157| settings, protection        | yes | yes | yes |
158| default branch              | yes | yes | yes |
159| merge requests only         | yes | yes | yes |
160| protected tags              | yes | yes | yes |
161| require codeowners          | yes | yes | yes |
162| access grants               | yes | no  | yes |
163| effective access            | yes | no  | yes |
164| webhooks                    | yes | no  | yes |
165| runners attach, list, detach| yes | yes | no  |
166| import from a remote        | yes | no  | yes |
167| topics, website             | yes | yes | yes |
168| visibility                  | yes | yes | yes |
169| archive (read-only flag)    | yes | yes | yes |
170| release list, show          | yes | yes | yes |
171| atom feeds                  | n/a | yes | n/a |
172| release create, edit        | yes | yes | yes |
173| build list                  | yes | yes | yes |
174| build show (one build)      | yes | yes | yes |
175| build log                   | yes | yes | yes |
176| build jobs                  | yes | yes | yes |
177| build trigger               | yes | yes | yes |
178| build cancel                | yes | yes | yes |
179| job image (ci.yml)          | yes | n/a | n/a |
180| dependency checks on/off    | yes | yes | yes |
181| dependency status           | yes | yes | yes |
182| delete, transfer            | yes | no  | no  |
183| rename                      | yes | no  | yes |
184| release delete              | yes | yes | yes |
185| release asset add           | yes | no  | n/a |
186| release asset remove        | yes | no  | yes |
187
188No row is web-only any more. Blame, file editing, log at a ref,
189archive, the public listing and the wiki were all in that state — a
190handler reading git or the store directly instead of dispatching a
191command — until krz/gitbay!99, !101 and !102 gave them commands.
192
193=build cancel= withdraws a queued build, or ends a running one: the
194server closes the runner's log session and the runner kills the step
195within a couple of seconds. Cancelling a duplicate of a commit that
196already passed the job puts that result back on the commit. The build
197page carries the button while a build is still cancellable.
198
199A pin and a bookmark are different things and are stored separately. A
200pin is private quick access to what you are working on, and drives the
201rail; a bookmark is public, says a repository is worth coming back to,
202and its count is the only popularity signal on the instance. Bookmarking
203needs read access only — it is something you do to someone else's
204repository — and a repository bookmarked while public and since made
205private drops out of the listing rather than leaking that it exists
206(krz/gitbay#146).
207
208The web's watch and pin controls write the store directly instead of
209dispatching =repo watch= and =repo pin=. That is why the web cannot
210mute: its toggle knows watching and default only.
211
212Dependency checks are off until a repository's admin turns them on: the
213check tells a public registry what the repository depends on. =repo deps
214status= lists what is behind; the repository's settings page renders the
215same report under the toggle — last check, last error, the tracking
216issue, and the rows. The issue the worker opens, rewrites and closes is
217still the copy every other surface reads.
218
219The wiki row covers reading. A wiki lives at =.gitbay/wiki/= on the
220default branch, so editing one is editing a file in the repository —
221a push, or =repo commit-file= — and there is no wiki-specific edit row
222to have parity on. The web editor reaches it on any repository that
223permits server-authored commits; one requiring verified signatures
224does not, because the server signs nothing on a user's behalf, so
225those wikis are push-only.
226
227=n/a= marks a capability deliberately absent from a surface rather than
228missing from it. Archive download is =n/a= on iOS: the read API carries
229a command's stdout as a JSON string, so a gzip stream cannot survive it,
230and the app has nowhere useful to put a tarball — the brief rules out
231local git, so there is no clone, checkout or build to feed. The web's
232route stays the way to get one. =release asset add= is =n/a= on iOS for
233the same reason from the other direction: the file arrives on stdin,
234which the API carries as a JSON string.
235
236A README or wiki page's org renders per surface: the web through
237go-org, the iOS client through the shared OrgSwift package
238(=krz/org-swift=). OrgSwift is held to orgo's output by the
239=krz/org-conformance= corpus — golden renderings from orgo, itself
240diffed against Emacs =ox-html= — so constructs the iOS client used to
241approximate (tables, footnotes, timestamps, heading tags, nested lists)
242now render the way the reference does. go-org is not yet on the corpus.
243
244* Discovery
245
246| capability                       | cli | web | ios |
247|----------------------------------+-----+-----+-----|
248| search repositories              | yes | yes | yes |
249| search issues and merge requests | yes | yes | yes |
250| browse all public repositories   | yes | yes | yes |
251| profile page                     | yes | yes | yes |
252| profile about and links          | yes | yes | yes |
253| activity feed                    | yes | yes | yes |
254| command reference                | yes | no  | n/a |
255
256=explore= is the listing without a query; =repo search= is the one with.
257=search= is both plus the title and body of every issue and merge
258request the caller can read, over FTS5; the web serves it at =/search=
259with a field in the rail, and an anonymous visitor gets the public rows
260from the same query. =issue list --search= and =mr list --search= narrow
261one repository. What someone types is quoted term by term, so an FTS5
262operator — =c++=, =AND=, a lone quote — is a word to match and never a
263syntax error. =repo grep= remains the per-repository file-contents
264search.
265
266About text renders as markdown or org-mode per the =about_format= it
267was stored with. The iOS client decodes and renders both,
268through the same OrgSwift path a README takes.
269
270=help= lists the command registry. Bare it is an index, one line per
271command, sorted. With a prefix (=help mr=) it adds each command's
272argument syntax, which is the only place flags are written down;
273=gitbay <cmd> --help= asks the server for the same thing, and =--json=
274returns ={path, summary, usage}=. No web page renders it, and a native
275client has no use for one (krz/gitbay#57).
276
277* Accounts
278
279| capability                  | cli | web | ios |
280|-----------------------------+-----+-----+-----|
281| SSH keys: list, add, remove | yes | yes | yes |
282| PGP keys: list, add, remove | yes | yes | yes |
283| email add and verify        | yes | yes | yes |
284| email list, remove, primary | yes | yes | yes |
285| dashboard aggregate         | yes | yes | yes |
286| notification inbox          | yes | yes | yes |
287| activity mail on, off       | yes | yes | yes |
288| API token mint              | yes | no  | no  |
289| account export bundle       | yes | yes | n/a |
290| profile set                 | yes | yes | yes |
291| request a login link        | n/a | yes | n/a |
292| account import bundle       | yes | no  | n/a |
293
294Notifications land in an inbox row per recipient whether or not the
295instance sends mail, and mail is the second half when SMTP is
296configured. =notifications list= reads it, unread by default;
297=notifications read <id>... | --all= clears it; the dashboard and the
298web rail carry the unread count. =repo watch= adds you to a
299repository's notifications, =repo mute= silences it, and =repo unwatch=
300returns you to the default from either — told about work you are part
301of, nothing more. A mute wins over owning the repository or having
302written the thread.
303
304A login link is requested from the login page by username or verified
305address, and arrives by mail: it works once and expires in fifteen
306minutes. The row is =n/a= for the CLI because a terminal with a
307registered key runs =web login=, which mints a link directly and needs
308no mail. It exists because an account with no SSH key had no way into
309the web at all (krz/gitbay#155). The page offers the form only when the
310instance has SMTP configured; there is no separate switch. The response
311never says whether the account exists. It is =n/a= on iOS for the same
312reason it is on the CLI, from the other end: the app authenticates with
313a bearer token pasted at sign-in, so a one-time link into the web
314unlocks nothing it can use.
315
316The account export bundle is =n/a= on iOS on the archive-download
317argument above — a JSON bundle has nowhere useful to land on a phone,
318and the web route stays the way to get one.
319
320=profile set= carries description, website, about and links. It is not
321=SSHOnly= — nothing about a bio is a credential, and the JSON API runs
322it. The account settings page has the form, and so does the iOS client:
323=--link= replaces the whole set rather than appending, so a client sends
324every link it keeps on every save, and =--link ''= is how they are
325cleared.
326
327* Organizations
328
329| capability                | cli | web | ios |
330|---------------------------+-----+-----+-----|
331| read members and teams    | yes | yes | yes |
332| members add, remove, role | yes | yes | yes |
333| teams create, delete      | yes | yes | yes |
334| team members              | yes | yes | yes |
335| team repo grants          | yes | yes | yes |
336| create, rename            | yes | yes | yes |
337| delete                    | yes | n/a | n/a |
338| profile                   | yes | no  | yes |
339
340* Pagination
341
342=issue list=, =mr list=, =repo list=, and =feed= take =--limit <n>=
343and =--cursor <c>=. Cursors are opaque; each page carries the next
344one. Without the flags a list stays complete, so existing scripts are
345unchanged. The web pages the issue and merge request lists at fifty
346with the same cursors; iOS pages with them too.
347
348* SSH only, by design
349
350Build secrets, mirror configuration and tokens, custom domain claims,
351API token minting, web session listing and revocation, deploy keys,
352account and instance administration. Deleting, transferring or renaming
353a repository is also CLI-only, as is deleting an organization: each
354removes or moves what clone URLs point at, and wants a typed command,
355not a button.
356
357These are the only rows where a =no= is intended. Everywhere else a
358=no= is work outstanding, and =n/a= means a surface cannot usefully
359carry the capability at all — see the archive note above.