Dokumentation

Kontroller, körningar och fynd

Läs en verifieringskörning, prioritera det som upptäcktes och avgör vad som ska åtgärdas.

En kontroll är en enskild verifiering. En körning är en körning av kontrollerna i en policy mot en ändring. Ett resultat är något som en kontroll har rapporterat.

En uppgifts iakttagelser finns i avsnittet Kvalitet , och varje körning finns under Inställningar → Aktivitet.

Läsa en körning

En körning visar varje kontroll, dess resultat och dess utdata. När en uppgift inte klarar verifieringen är det i körningen du ser varför.

Läs uppifrån och ned. Den första kontrollen som misslyckas är vanligtvis den verkliga orsaken — senare misslyckanden är ofta följder av den. Ett byggfel följt av tolv testfel är ett problem, inte tretton.

Resultat

Iakttagelser kommer från granskningsagenter, skannrar och rådgivande kontroller. Varje iakttagelse innehåller vad som upptäcktes, var det upptäcktes och hur allvarligt det är. En iakttagelse för en uppgift hör till den uppgiften. Ett testfel som inte hör till någon uppgift väntar i Mjukvarufabrik under Granskning, där du åtgärdar det eller godkänner det med en motivering. En kontroll som inte kan köras i ett projekt, till exempel enhetstester utan testramverk, anges på sin rad under Kvalitetskontroll.

Deras livscykel:

  1. Rapporterat av en kontroll eller granskare.
  2. Vidarebefordrat — resultat som kan åtgärdas skickas tillbaka till utvecklaragenten som omarbete; resten kopplas till pull request.
  3. Löst — åtgärdat, accepterat eller undertryckt.

Flaggade

  • En rådgivande kontroll
  • Granskningsagenten
  • En ansluten skanner

Vidarebefordrade

Åtgärdbara

Tillbaka till utvecklaren för omarbete

Allt annat

Bifogas till pull request

Löst

  • Åtgärdat

    Ändringen åtgärdar fyndet

  • Accepterat

    Det stämmer, men är inte värt att agera på här. Ange varför.

  • Ignorerat

    Ett falskt positivt resultat eller en regel som inte gäller. Ange varför.

Fynd som går att åtgärda hanteras under körningen. Övriga hamnar i pull request, och varje fynd slutar som åtgärdat, accepterat eller undertryckt, med en motivering till de två sistnämnda.

Prioritera

Frågan för varje resultat är inte "stämmer det här?" utan "påverkar det här vad som händer härnäst?"

  • Åtgärda nu — korrekthet, säkerhet och allt som ändå skulle underkännas i granskningen.
  • Acceptera — stämmer, men är inte värt att agera på här. Dokumentera varför.
  • Undertryck — ett falskt positivt resultat eller en regel som inte gäller för den här koden.

Undertryck medvetet och ange en orsak. Ett oförklarat undertryckande går inte att skilja från att någon försöker tysta en obekväm sanning, och sex månader senare kan ingen säga vilket det var.

När det finns för många resultat

Mängden är en signal om konfigurationen, inte om kodkvaliteten.

En kontroll som utlöses vid de flesta ändringar hittar inte problem — den beskriver din kodbas. Antingen passar regeln inte dina konventioner, eller så beskriver den teknisk skuld som du har bestämt dig för att leva med. I båda fallen är kontrollen fel utformad.

Resultat och grindar

Ett resultat från en rådgivande grind är information. Samma resultat från en blockerande g grind stoppar uppgiften. Resultatet är identiskt; policyn avgör vad det kostar.

Det är reglaget att använda när en kontroll är korrekt men för aggressiv: ändra dess allvarlighetsgrad i stället för att ta bort den. Se Kvalitetspolicyer och grindar.