Pāriet uz galveno saturu
Izstrādātājiem Ziņu kartītes

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.

  1. Galvene„Message from“ un nosaukums: webhook nosaukums vai, ja tā ir atbilde uz komandu, tavas kopienas nosaukums. Atbilde var pievienot badge, piemēram, repozitoriju.
  2. Virsraksts un statusstitle, kas kļūst par saiti, ja iestati title_url, ar status birku blakus.
  3. ApakšvirsrakstsOtrā treknā rinda, sub_title.
  4. AprakstsPamatteksts, markdown formātā.
  5. LaukiNosaukuma un vērtības rindas ar kopēšanas pogu.
  6. KājeneLaiks, kā arī pievienotās un dzēstās rindas, ja tās nosūti.
json
{
  "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.

LauksTipsKo tas dara
typestringembed_message (noklusējums) vai system_message.
badgestringNeliela nozīmīte aiz nosaukuma galvenē, piemēram, acme/web. Komandu atbildes
avatar_urlstringAttēls pāri kartītes ikonai.
colorstringMalas krāsa. Skati krāsas zemāk.
titlestringTreknā pirmā rinda.
title_urlstringPārvērš virsrakstu par saiti.
sub_titlestringOtrā treknā rinda zem virsraksta.
descriptionstringPamatteksts, markdown formātā.
fieldsarray[{ "field": "…", "value": "…" }]: nosaukuma un vērtības rindas.
image_url, image_base64stringAttēls kartītē.
imagesarray[{ "image_url": "…" }]: vairāku attēlu galerija.
statusobject vai stringKrāsaina birka blakus virsrakstam. Skati zemāk. Komandu atbildes
additions, deletions, files_changednumberDiff statistika kājenē. Komandu atbildes
loader, loader_text, loader_sub_textboolean, stringRotējošs indikators pamatteksta vietā.
thinkingstringSpriešana aiz slēdža Show thinking. Komandu atbildes
Apraksts un 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.

json
{
  "message_container": {
    "color": "red",
    "title": "Build failed on main",
    "status": { "label": "Failing", "color": "red" },
    "description": "`search.test.js`: 2 of 212 tests failed."
  }
}
LauksTipsKo tas dara
statusobject vai stringVienkārša virkne ir etiķete: "status": "Open".
status.labelstringBirkas teksts. Bez tā birkas nav.
status.colorstringgreen, purple, red, orange, yellow, blue vai gray.
status.iconstringIkona pēc izvēles no saraksta zemāk.
additionsnumberPievienotās rindas, redzamas kā zaļš +86.
deletionsnumberDzēstās rindas, redzamas kā sarkans -12.
files_changednumberMainītie faili, redzami kā 3 files.

Ikonas

VērtībaIkonaTipisks lietojums
pull_requestgit-pull-requestAtvērts pull request
pull_request_closedgit-pull-request-closedAizvērts bez sapludināšanas
merge, mergedgit-mergeSapludināts
commitgit-commitAr push nosūtīts commit
issuecircle-dotAtvērts issue
issue_closedcircle-checkAizvērts issue
checkcircle-checkTesti 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.

NotikumsEtiķeteKrāsaIkona
Atvērts pull requestOpengreenpull_request
MelnrakstsDraftgraypull_request
SapludinātsMergedpurplemerged
Aizvērts bez sapludināšanasClosedredpull_request_closed
Atvērts issueOpengreenissue
Aizvērts issueClosedpurpleissue_closed
Ar push nosūtīts commitCommitgraycommit
Testi izdevāsPassinggreencheck
Testi neizdevāsFailingrednav

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.

assistant
System
Message from Assistant
Domāju…Lasu pēdējās 50 ziņas

Vispirms: ielādes indikators

assistant
System
Message from Assistant

maya: kad ir standup?

Standup ir 09:30, kanālā #daily.
Pārbaudīju piespraustās ziņas un regulāro notikumu kanālā #daily.

Pēc tam: atbilde ar sakļautu spriešanu

json
{
  "message_container": {
    "type": "embed_message",
    "color": "blue",
    "loader": true,
    "loader_text": "Thinking…",
    "loader_sub_text": "Reading the last 50 messages"
  }
}
json
{
  "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…"
  }
}
LauksTipsKo tas dara
loaderbooleantrue rāda rotējošo indikatoru pamatteksta vietā.
loader_textstringRinda blakus indikatoram, piemēram, „Domāju…“.
loader_sub_textstringMazāka rinda zem tās.
thinkingstringSakļ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.

json
{
  "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āsaKam to lietot
greenVeiksme: izdevies, izvietots, gatavs
redKļūme: neizdevās, nedarbojas, noraidīts
orangeBrīdinājums, kam jāpievērš uzmanība
yellowGaida kādu: apstiprinājumi, jautājumi
blueInformācija, noklusējums
purpleKoda 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.

Veidnes
Pogas
Priekšskatījums
Webhook body

Veido tālāk