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