Kujunda sõnumikaarte
Kõik, mida bot postitab, olgu webhookist, käsu vastusena või nupuvajutuse järel uuendusena, on kaart. Hea kaart ütleb ühe pilguga, mis juhtus: värviline serv, pealkiri, olek ja selle all üksikasjad.
Mida saad teha
- Näita olekutVärviline silt nagu Open, Merged või Passing, koos lisatud ja eemaldatud ridadega.
- Loetle üksikasjadSildi ja väärtusega read, mida liikmed saavad ühe puudutusega kopeerida.
- Kirjuta markdownisPaks kiri, tekstisisene kood, koodiplokid, tsitaadid ja märkeruudud.
- Näita, et töötadLaadimisring, kuni bot mõtleb, ja pärast seda tema arutluskäik lüliti taga.
Rakenduses
Neli kaarti nii, nagu liikmed neid näevad. Igaüks neist on paar rida JSON-i.
Kaardi ülesehitus
Kaardi osad ülevalt alla. Jäta ära, mida sul vaja pole: ka ainult pealkirjaga kaart sobib.
- Päis„Message from“ ja nimi: webhooki nimi või käsu vastuse puhul sinu kogukonna nimi. Vastus võib lisada märgi
badge, näiteks repositooriumi nime. - Pealkiri ja olek
title, mis on link, kui määradtitle_url, ja selle kõrval olekusiltstatus. - AlapealkiriTeine paksus kirjas rida,
sub_title. - KirjeldusSisu markdownis.
- VäljadSildi ja väärtusega read, kopeerimisnupuga.
- JalusKellaaeg ning lisatud ja eemaldatud read, kui need saadad.
{
"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
}
}Kõik väljad
Need käivad välja message_container alla. Kaardil peab olema kirjeldus või laadija. Väljad märkega „Käskude vastused“ jäetakse webhooki kaudu postitades välja.
| Väli | Tüüp | Mida see teeb |
|---|---|---|
type | string | embed_message (vaikimisi) või system_message. |
badge | string | Väike märk päises nime järel, näiteks acme/web. Käskude vastused |
avatar_url | string | Pilt kaardi ikooni peal. |
color | string | Serva värv. Vaata värve allpool. |
title | string | Paksus kirjas esimene rida. |
title_url | string | Muudab pealkirja lingiks. |
sub_title | string | Teine paksus kirjas rida pealkirja all. |
description | string | Sisu markdownis. |
fields | array | [{ "field": "…", "value": "…" }]: sildi ja väärtusega read. |
image_url, image_base64 | string | Pilt kaardil. |
images | array | [{ "image_url": "…" }]: mitme pildi galerii. |
status | object või string | Värviline silt pealkirja kõrval. Vaata allpool. Käskude vastused |
additions, deletions, files_changed | number | Diff-statistika jaluses. Käskude vastused |
loader, loader_text, loader_sub_text | boolean, string | Laadimisring sisu asemel. |
thinking | string | Arutluskäik lüliti Show thinking taga. Käskude vastused |
thinking mõistavad markdowni: **bold**, _italic_, ~~strike~~, `inline code`, kolme graavise vahel koodiplokid, > quotes, märkeruudud - [x], @mainimised ja :emoji:.Olek ja diff-statistika
Olekusilt räägib loo ära enne, kui keegi teksti loeb. See on pealkirja kõrval või, kui pealkirja pole, jaluses; diff-statistika on kellaaja kõrval. Mõlemad töötavad käskude vastustes ja sisseehitatud GitHubi integratsioon kasutab neid. Webhook jätab need välja.
{
"message_container": {
"color": "red",
"title": "Build failed on main",
"status": { "label": "Failing", "color": "red" },
"description": "`search.test.js`: 2 of 212 tests failed."
}
}| Väli | Tüüp | Mida see teeb |
|---|---|---|
status | object või string | Paljas string on silt: "status": "Open". |
status.label | string | Sildi tekst. Ilma selleta silti ei ole. |
status.color | string | green, purple, red, orange, yellow, blue või gray. |
status.icon | string | Valikuline ikoon allolevast loendist. |
additions | number | Lisatud read, kuvatakse rohelisena: +86. |
deletions | number | Eemaldatud read, kuvatakse punasena: -12. |
files_changed | number | Muudetud failid, kuvatakse kujul 3 files. |
Ikoonid
| Väärtus | Ikoon | Tüüpiline kasutus |
|---|---|---|
pull_request | git-pull-request | Pull request avati |
pull_request_closed | git-pull-request-closed | Suleti ühendamata |
merge, merged | git-merge | Ühendatud |
commit | git-commit | Pushitud commit |
issue | circle-dot | Issue avati |
issue_closed | circle-check | Issue suleti |
check | circle-check | Testid läbitud, töö õnnestus |
GitHubi jaoks toimiv vastendus
Sisseehitatud GitHubi integratsioon kasutab neid; kopeeri need oma tööriistadesse.
| Sündmus | Silt | Värv | Ikoon |
|---|---|---|---|
| Pull request avati | Open | green | pull_request |
| Mustand | Draft | gray | pull_request |
| Ühendatud | Merged | purple | merged |
| Suleti ühendamata | Closed | red | pull_request_closed |
| Issue avati | Open | green | issue |
| Issue suleti | Closed | purple | issue_closed |
| Commit pushiti | Commit | gray | commit |
| Testid läbitud | Passing | green | check |
| Testid ebaõnnestusid | Failing | red | puudub |
Laadija ja arutluskäik
Kõige jaoks, mis võtab hetke, näiteks TI vastus või pikk töö, postita kõigepealt laadimisringiga kaart ja asenda see siis tulemusega. Laadija töötab nii webhookides kui ka käskude vastustes. Käsu vastuses saad mudeli arutluskäigu panna ka välja thinking: liikmed näevad tekstimüüri asemel lülitit Show thinking.
Kõigepealt: laadija
Siis: vastus, arutluskäik kokku volditud
{
"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…"
}
}| Väli | Tüüp | Mida see teeb |
|---|---|---|
loader | boolean | true näitab sisu asemel laadimisringi. |
loader_text | string | Rida laadimisringi kõrval, näiteks „Mõtlen…“. |
loader_sub_text | string | Väiksem rida selle all. |
thinking | string | Kokkuvolditud arutluskäik kirjelduse all, markdownis. |
Et laadija vastusega asendada, uuenda sõnumit uue kaardiga, milles pole välja loader. Kuidas, loe lehelt reaalajas uuendused.
Pikad kirjeldused
Kirjeldus võib olla kuni 50 000 baiti. Pärast esimest 1000 baiti näevad liikmed algust ja nuppu Show more, mis laadib ülejäänu, nii et pikk raport ei uputa kanalit.
Süsteemisõnumid
Määra "type": "system_message", kui tegu on teadaande, mitte boti postitusega: hooldusaknad, reeglite muudatused, kõik, mis räägib kogukonna enda nimel. See võtab vastu samad väljad ja nupud.
{
"message_container": {
"type": "system_message",
"color": "orange",
"title": "Maintenance tonight",
"description": "The build servers are down from 22:00 to 23:00."
}
}Värvid
Serva värv on kaardi kiireim signaal. Kasuta sama liiki uudiste jaoks alati sama värvi.
| Värv | Kasuta seda |
|---|---|
green | Õnnestumine: läbitud, paigaldatud, valmis |
red | Ebaõnnestumine: nurjus, maas, tagasi lükatud |
orange | Hoiatus, mis vajab pilku |
yellow | Ootab kellegi järel: kinnitused, küsimused |
blue | Info, vaikimisi |
purple | Koodisündmused või midagi erilist |
Koosta oma embed
Muuda välju või JSON-payloadi: mõlemad püsivad sünkroonis. Eelvaade näitab sõnumit täpselt nii, nagu see kanalis paistab. See on päris webhooki sisu (body); kopeeri see, kui kõik näeb õige välja.