Actions with confirmation cards
Lumen never changes anything by itself. When a change would help, it proposes a card. You see exactly what would change, and nothing happens until you press Run.
How a card works
Section titled “How a card works”A card shows:
- a title for the change and the product it is for;
- the fields and a preview of what will be sent. Some fields, such as a summary or description, can be edited on the card;
- Run, and Dismiss.
Until you press Run, nothing has changed, and Lumen is told so: “nothing has changed yet”.
Your browser performs the change. When you press Run, your browser calls the product’s API with your own session, on the same origin, to /api/v1/ paths only. The Lumen server has no write path to any product: every request it makes to a product is a read. Because the request is yours, the product’s permissions, validation and audit apply exactly as if you had used the interface. The result is sent back to Lumen, so a follow-up question knows what became of the card.
Orbit cards
Section titled “Orbit cards”| Card | Notes |
|---|---|
| Create a work item | Follows the create screen of the project: its required fields are shown on the card and can be filled in |
| Comment | A comment on a work item |
| Transition | Names the target status. When you run it, your browser picks the transition to that status and reads the current versions first |
| Link | Link two work items |
| Field changes | Priority, labels, estimate, due date, summary or description. Only the fields that change are sent, never the status. The version Lumen read is sent with the request, so if someone else edited the item in the meantime, Orbit answers 409 instead of overwriting their change |
| Approval request | Asks for an approval |
Errors from Orbit (such as 409 and 422) are shown to you as they are.
Work breakdown
Section titled “Work breakdown”Ask Lumen to break a description or an epic into sub-tasks or child items. The result is a list of up to 10 cards for the same parent, shown as one list. You can edit each summary, open Details to edit the description, Remove a row, and press Run all to create the rest after one confirmation. Each row reports its own result: a link to the new work item, or the error from Orbit.
Forge cards
Section titled “Forge cards”- Review comments: for “Review this merge request”, Lumen reads the changed files with line numbers and proposes comments on specific lines, replies to discussions or general comments as cards. Your browser posts them after you confirm.
- A change to the CI configuration: Lumen proposes a whole
.gitlab-ci.yml. The card checks it with Forge’s CI lint, as you, when it is shown and again before it can run. A draft with errors cannot be run; Fix with Lumen asks again with the errors. For a review, three cards in order create a branch, put the file on it and open a merge request. The commit is made with your rights against the head of the branch.
Folio cards
Section titled “Folio cards”A new Folio page is proposed as a card. Text that Lumen writes for the Folio editor is inserted into your draft; it is never published by itself.
Pulse cards
Section titled “Pulse cards”A new monitor is proposed with its type, query, threshold, window and options. The card validates the draft with Pulse (monitors/validate) and shows any error against the field, so an invalid monitor cannot run.
Orbit automation rules
Section titled “Orbit automation rules”An Orbit automation rule is proposed the same way, and the card validates it with Orbit before you can run it. The conditions and actions can be edited as JSON.
The action log
Section titled “The action log”Every proposal is recorded: what was proposed, in which answer, whether it was run, dismissed or failed, whether you edited it, the status and a link to the result. The author can read their own entries, and Orbit administrators see all of them under Changes in the Admin tab of the Lumen panel.