Veido ziņu kartītes
Viss, ko bots publicē, vai tas būtu no webhook, atbilde uz komandu vai atjauninājums pēc pogas nospiešanas, ir kartīte. Laba kartīte vienā acu uzmetienā pasaka, kas noticis: krāsaina mala, virsraksts, statuss un zem tā detaļas.
Ko tu vari darīt
- Parādi statusuKrāsaina birka, piemēram, Open, Merged vai Passing, ar pievienoto un dzēsto rindu skaitu.
- Uzskaiti detaļasNosaukuma un vērtības rindas, ko dalībnieki var nokopēt ar vienu pieskārienu.
- Raksti markdownTreknraksts, iekļauts kods, koda bloki, citāti un izvēles rūtiņas.
- Parādi, ka strādāRotējošs indikators, kamēr bots domā, un pēc tam tā spriešana aiz slēdža.
Lietotnē
Četras kartītes tā, kā tās redz dalībnieki. Katra ir tikai dažas JSON rindas.
Kartītes uzbūve
Kartītes daļas no augšas uz leju. Izlaid to, kas nav vajadzīgs: kartīte tikai ar virsrakstu arī der.
- Galvene„Message from“ un nosaukums: webhook nosaukums vai, ja tā ir atbilde uz komandu, tavas kopienas nosaukums. Atbilde var pievienot
badge, piemēram, repozitoriju. - Virsraksts un statuss
title, kas kļūst par saiti, ja iestatititle_url, arstatusbirku blakus. - ApakšvirsrakstsOtrā treknā rinda,
sub_title. - AprakstsPamatteksts, markdown formātā.
- LaukiNosaukuma un vērtības rindas ar kopēšanas pogu.
- KājeneLaiks, kā arī pievienotās un dzēstās rindas, ja tās nosūti.
{
"message_container": {
"type": "embed_message",
"badge": "acme/web",
"color": "purple",
"title": "Pull request #212 opened",
"title_url": "https://github.com/acme/web/pull/212",
"status": { "label": "Open", "color": "green", "icon": "pull_request" },
"sub_title": "Faster search in the channel list",
"description": "Search now runs **per keystroke** with a 120 ms debounce.",
"fields": [
{ "field": "Author", "value": "maya" },
{ "field": "Reviewers", "value": "dani, sam" }
],
"additions": 86,
"deletions": 12,
"files_changed": 3
}
}Visi lauki
Šie lauki tiek likti message_container. Kartītei vajadzīgs apraksts vai ielādes indikators. Lauki ar atzīmi „Komandu atbildes“ tiek izmesti, ja publicē caur webhook.
| Lauks | Tips | Ko tas dara |
|---|---|---|
type | string | embed_message (noklusējums) vai system_message. |
badge | string | Neliela nozīmīte aiz nosaukuma galvenē, piemēram, acme/web. Komandu atbildes |
avatar_url | string | Attēls pāri kartītes ikonai. |
color | string | Malas krāsa. Skati krāsas zemāk. |
title | string | Treknā pirmā rinda. |
title_url | string | Pārvērš virsrakstu par saiti. |
sub_title | string | Otrā treknā rinda zem virsraksta. |
description | string | Pamatteksts, markdown formātā. |
fields | array | [{ "field": "…", "value": "…" }]: nosaukuma un vērtības rindas. |
image_url, image_base64 | string | Attēls kartītē. |
images | array | [{ "image_url": "…" }]: vairāku attēlu galerija. |
status | object vai string | Krāsaina birka blakus virsrakstam. Skati zemāk. Komandu atbildes |
additions, deletions, files_changed | number | Diff statistika kājenē. Komandu atbildes |
loader, loader_text, loader_sub_text | boolean, string | Rotējošs indikators pamatteksta vietā. |
thinking | string | Spriešana aiz slēdža Show thinking. Komandu atbildes |
thinking saprot markdown: **bold**, _italic_, ~~strike~~, `inline code`, norobežotus koda blokus, > quotes, izvēles rūtiņas - [x], @pieminējumus un :emoji:.Statuss un diff statistika
Statusa birka izstāsta notikušo, pirms kāds izlasa tekstu. Tā atrodas blakus virsrakstam vai, ja virsraksta nav, kājenē; diff statistika redzama blakus laikam. Abas darbojas komandu atbildēs, un tās izmanto iebūvētā GitHub integrācija. Webhook tās izmet.
{
"message_container": {
"color": "red",
"title": "Build failed on main",
"status": { "label": "Failing", "color": "red" },
"description": "`search.test.js`: 2 of 212 tests failed."
}
}| Lauks | Tips | Ko tas dara |
|---|---|---|
status | object vai string | Vienkārša virkne ir etiķete: "status": "Open". |
status.label | string | Birkas teksts. Bez tā birkas nav. |
status.color | string | green, purple, red, orange, yellow, blue vai gray. |
status.icon | string | Ikona pēc izvēles no saraksta zemāk. |
additions | number | Pievienotās rindas, redzamas kā zaļš +86. |
deletions | number | Dzēstās rindas, redzamas kā sarkans -12. |
files_changed | number | Mainītie faili, redzami kā 3 files. |
Ikonas
| Vērtība | Ikona | Tipisks lietojums |
|---|---|---|
pull_request | git-pull-request | Atvērts pull request |
pull_request_closed | git-pull-request-closed | Aizvērts bez sapludināšanas |
merge, merged | git-merge | Sapludināts |
commit | git-commit | Ar push nosūtīts commit |
issue | circle-dot | Atvērts issue |
issue_closed | circle-check | Aizvērts issue |
check | circle-check | Testi izdevās, uzdevums izpildīts veiksmīgi |
Kartējums, kas der GitHub
Iebūvētā GitHub integrācija izmanto šīs vērtības; nokopē tās saviem rīkiem.
| Notikums | Etiķete | Krāsa | Ikona |
|---|---|---|---|
| Atvērts pull request | Open | green | pull_request |
| Melnraksts | Draft | gray | pull_request |
| Sapludināts | Merged | purple | merged |
| Aizvērts bez sapludināšanas | Closed | red | pull_request_closed |
| Atvērts issue | Open | green | issue |
| Aizvērts issue | Closed | purple | issue_closed |
| Ar push nosūtīts commit | Commit | gray | commit |
| Testi izdevās | Passing | green | check |
| Testi neizdevās | Failing | red | nav |
Ielāde un spriešana
Visam, kas aizņem brīdi, piemēram, MI atbildei vai ilgam darbam, vispirms publicē kartīti ar rotējošu indikatoru un pēc tam aizstāj to ar rezultātu. Ielādes indikators darbojas webhook un komandu atbildēs. Komandas atbildē modeļa spriešanu vari ielikt arī laukā thinking: dalībnieki redz slēdzi Show thinking, nevis teksta sienu.
Vispirms: ielādes indikators
Pēc tam: atbilde ar sakļautu spriešanu
{
"message_container": {
"type": "embed_message",
"color": "blue",
"loader": true,
"loader_text": "Thinking…",
"loader_sub_text": "Reading the last 50 messages"
}
}{
"message_container": {
"type": "embed_message",
"color": "blue",
"sub_title": "maya: when is the standup?",
"description": "Standup is at **09:30**, in #daily.",
"thinking": "Checked the pinned messages and the recurring event in #daily…"
}
}| Lauks | Tips | Ko tas dara |
|---|---|---|
loader | boolean | true rāda rotējošo indikatoru pamatteksta vietā. |
loader_text | string | Rinda blakus indikatoram, piemēram, „Domāju…“. |
loader_sub_text | string | Mazāka rinda zem tās. |
thinking | string | Sakļauta spriešana zem apraksta, markdown formātā. |
Lai ielādes indikatoru nomainītu pret atbildi, atjaunini ziņu ar jaunu kartīti bez loader. Kā to izdarīt, skaidrots lapā atjauninājumi reāllaikā.
Gari apraksti
Apraksts var būt līdz 50 000 baitiem. Pēc pirmajiem 1000 dalībnieki redz sākumu un pogu Show more, kas ielādē pārējo, tāpēc gara atskaite nepārpludina kanālu.
Sistēmas ziņas
Iestati "type": "system_message", ja tas ir paziņojums, nevis bota ieraksts: apkopes logi, noteikumu izmaiņas, viss, kas runā pašas kopienas vārdā. Tai ir tie paši lauki un pogas.
{
"message_container": {
"type": "system_message",
"color": "orange",
"title": "Maintenance tonight",
"description": "The build servers are down from 22:00 to 23:00."
}
}Krāsas
Malas krāsa ir ātrākais signāls kartītē. Vienam un tam pašam ziņu veidam vienmēr lieto vienu un to pašu krāsu.
| Krāsa | Kam to lietot |
|---|---|
green | Veiksme: izdevies, izvietots, gatavs |
red | Kļūme: neizdevās, nedarbojas, noraidīts |
orange | Brīdinājums, kam jāpievērš uzmanība |
yellow | Gaida kādu: apstiprinājumi, jautājumi |
blue | Informācija, noklusējums |
purple | Koda notikumi vai kaut kas īpašs |
Izveido savu embed
Rediģē laukus vai JSON payload. Abi vienmēr sakrīt. Priekšskatījumā ziņa izskatās tieši tā, kā tā parādīsies kanālā. Tas ir īstais webhook body; nokopē to, kad viss izskatās pareizi.