Læringssti 07Lektion 6 / 8

Gennemgå en Taiga-leverance med dokumentation

Forbind initiativ, plan, kørsel, diff og kontroller. Verificér den aktuelle ændring, før en merge- eller releasebeslutning accepteres.

Praktisk11 minReviewet

Udgivet af Sådan skriver vi

Det lærer du

  • Spor en leveret adfærd tilbage til kravet og planen.
  • Identificér ufuldstændige kontroller og antagelser, der kræver review.
  • Skeln mellem afsluttet kørsel, merge, udrulning og tilgængelighed for brugere.

Start med initiativets resultat

Den fiktive udstyrstjeneste lader nu medarbejdere se deres egne anmodninger. Start review med initiativets resultat og omfang. Identificér, hvad der skal være sandt, og hvad ændringen skal bevare.

I denne leverance må en medarbejder ikke læse en anden medarbejders anmodning. Ledere skal beholde deres definerede adgang. En test, der kun åbner siden, dokumenterer ingen af betingelserne.

Forbind registreringerne

RegistreringReviewspørgsmål
InitiativHvilket resultat og omfang blev autoriseret?
PlanversionHvilke implementerings- og verifikationstrin var tilsigtet?
KørselHvad skete der, og hvilke antagelser gjorde agenten?
Pull request og diffHvad ændrede sig i det aktuelle commit?
Kontroller og reviewHvilken dokumentation understøtter accept af dette commit?
UdrulningsregistreringHvilket artefakt nåede hvilket miljø?

Siden Runs registrerer forsøg, også fejlede. Hver kørsel identificerer den plan, den udførte. En kørselsside er en registrering til inspektion; beslutninger, der ændrer arbejdet, hører til på initiativet.

Læs trindokumentationen for tests og formatering. Taiga gør fejlede eller ikke-udførte kontroller synlige. Omsæt ikke »ikke kørt« til »bestået« i dit reviewresumé.

Undersøg antagelser og grænser

Se efter antagelser om adgangsmodel, skema, miljø og eksterne tjenester. Sammenlign dem med den publicerede hensigt og den faktiske kode.

Undersøg i udstyrstjenesten, hvor anmodningens ejer kontrolleres. Test en autoriseret anmodning, en anden medarbejders anmodning og en manglende anmodning. Kontrollér, at logs ikke afslører fortroligt indhold fra anmodninger.

Gennemgå også testændringerne. Et bestået resultat har begrænset værdi, hvis ændringen fjernede den assertion, der ville opdage fejlen. Medtag ændringer af workflows og testkonfiguration i reviewets omfang.

Giv feedback, der kan handles på

Identificér adfærd, forventet resultat og nødvendig dokumentation. For eksempel: »Endpointet kontrollerer login, men ikke ejerskab til anmodningen. Tilføj adgangskontrollen på serveren og en test med en anden medarbejders anmodning.«

Taiga kan reagere på reviewfeedback til pull requests og fejlede kontroller med ændringer på samme branch. Undersøg det nye commit og dets kontroller efter opdateringer. Tidligere dokumentation dækker måske ikke et ændret artefakt.

Hvis kørslen stoppede, fordi planen var ufuldstændig eller en kontrol blev svækket, skal du læse den angivne årsag. Fjern ikke kladdestatus, blot fordi den synlige kontroloversigt er grøn.

Træf den rette acceptbeslutning

Registrér, hvilke kriterier der er verificeret, og hvilke der stadig er uløste. Lad repositoryets påkrævede reviews og kontroller håndhæve mergegrænsen. Bevar enhver særskilt releasebeslutning.

Taiga observerer de udrulninger, din pipeline udfører. Verificér miljø og artefakt, før du fortæller brugerne, at ændringen er tilgængelig. En fejlet udrulning kan efterlade den tidligere vellykkede version med at betjene trafikken.

Afslut resultatet med en kontrol på tjenesteniveau: Medarbejderen kan bruge funktionen, uautoriseret adgang afvises, og den driftsansvarlige kan observere fejl. Fortsæt med håndtering af en afbrydelse.

Lav øvelsen

En fiktiv ændring af medarbejderadgang har et bestået build og en kørselsnote om, at en integrationstest ikke kunne køre. Skriv den nødvendige dokumentation før accept. Medtag ét tilfælde med afvist adgang og det præcise artefakt eller commit, der gennemgås.

Download arbejdsark (Markdown)

Kontrollér din forståelse

Kørslen er færdig, men registreringen siger, at en påkrævet test ikke kørte. Hvad dokumenterer færdiggørelsen?

Kilder og videre læsning

Relateret læsning fra Taiga