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