Vad är commit-grinden?

Commit-grinden är en valfri funktion i AI Diff Review som automatiskt granskar dina kodändringar innan du committar dem. Baserat på analysresultaten kan den rekommendera att blockera en commit om den upptäcker högriskproblem. Detta fungerar som ett automatiserat säkerhetsnät som fångar problem innan de når ditt repository.

Grinden är designad för att vara intelligent och nyanserad—den blockerar inte varje mindre problem, utan fokuserar på verkligen problematiska ändringar som kan orsaka säkerhetssårbarheter, dataförlust eller allvarliga funktionalitetsbrott.

Hur commit-grinden fungerar

Vägt poängsättningssystem

Commit-grinden använder ett sofistikerat vägt poängsättningssystem för att utvärdera allvarligheten av resultat. Olika typer av problem bidrar med olika belopp till den totala poängen:

  • Säkerhetsbekymmer: KRITISK=5, VARNING=3, INFO=2
  • Kritiska problem: KRITISK=4, VARNING=3, INFO=2
  • Prestandaanteckningar: VARNING=1.5, INFO=0.5
  • Förslag: VARNING=1, INFO=0.5
  • Kodkvalitet: VARNING=1, INFO=0.5
  • Testrekommendationer: VARNING=0.5, INFO=0.25

Denna viktning säkerställer att säkerhetsproblem och kritiska problem har större inverkan på beslutet än mindre förslag eller stilrekommendationer.

Allvarlighetsnivåer

Commit-grinden erbjuder tre allvarlighetsnivåer som bestämmer hur strikt blockeringsbeteendet är:

INFO-nivå

Blockerar commits när den totala vägda poängen når 4.0 eller högre. Detta är den mest milda inställningen, lämplig för team som vill fånga endast de allvarligaste problemen.

VARNING-nivå

Blockerar commits när den totala vägda poängen når 6.0 eller högre. Detta ger en balanserad approach, fångar betydande problem samtidigt som mindre problem tillåts passera.

KRITISK-nivå

Blockerar commits när den totala vägda poängen når 8.0 eller högre, ELLER när något KRITISKT objekt hittas i kategorierna Säkerhetsbekymmer eller Kritiska problem. Detta är den striktaste inställningen, säkerställer att allvarliga problem aldrig når repositoryt.

Hårdblockeringsvillkor

Vissa villkor utlöser alltid en blockeringsrekommendation, oavsett den totala poängen:

  • Alla objekt med KRITISK allvarlighetsgrad i Säkerhetsbekymmer
  • Högrisksäkerhetsproblem såsom:
    • Hemlighetsläckor eller exponerade autentiseringsuppgifter
    • SQL-injektionssårbarheter
    • Fjärrkodkörningsrisker (RCE)
    • Autentiseringsbypass-problem
    • Privilegieeskaleringssårbarheter

Dessa hårdblockeringsvillkor säkerställer att allvarliga säkerhetssårbarheter aldrig av misstag committas, även om den totala poängen är låg.

Explicita AI-rekommendationer

Utöver det vägda poängsättningssystemet kan AI-modellen explicit rekommendera att blockera en commit genom att sätta should_block_commit=true i sitt svar. När detta händer kommer pluginet att rekommendera att blockera commiten och tillhandahålla AI:ns resonemang i fältet block_reason.

Detta tillåter AI:n att fatta nyanserade beslut baserat på kontext som kanske inte fångas av poängsättningssystemet ensamt. Till exempel kan AI:n upptäcka ett mönster av problem som, även om de individuellt är mindre, kollektivt representerar ett betydande problem.

Beslutsfattande med mänsklig inblandning

Commit-grinden förhindrar inte automatiskt att du committar—den ger en rekommendation och ger dig sista ordet. När du försöker committa med grinden aktiverad kommer du att se en beslutsdialog som visar:

  • Grindens rekommendation (BLOCKERA eller FORTSÄTT)
  • Total poäng och tröskelvärde
  • Antal resultat per allvarlighetsgrad
  • Sammanfattning av viktiga resultat
  • Toppbidragande problem

Denna transparens hjälper dig förstå varför en commit flaggades och fatta ett informerat beslut. Om du väljer att fortsätta trots en BLOCKERA-rekommendation kan du ange en anledning som kommer att läggas till ditt commit-meddelande.

Konfigurera commit-grinden

Aktivera grinden

För att aktivera commit-grinden, gå till Inställningar → Verktyg → AI Diff Review och kryssa i "Aktivera pre-commit-granskning". Du kan sedan välja din föredragna grindallvarlighetsnivå.

Välja rätt nivå

Rätt allvarlighetsnivå beror på ditt teams behov:

  • INFO: Bra för team som precis börjar med automatiserad granskning eller de med mycket erfarna utvecklare
  • VARNING: Balanserad option för de flesta team, fångar betydande problem utan att vara för restriktiv
  • KRITISK: Bäst för säkerhetskänsliga projekt eller team som vill ha maximalt skydd

Diff-omfattningsmedvetenhet

Commit-grinden är medveten om diff-omfattningsinställningar. Som standard bidrar endast resultat kopplade till ändrade rader (eller inom ett litet närhetsfönster) till poängsättningen. Globala eller icke-målade INFO-objekt ignoreras typiskt för grindändamål, vilket säkerställer att grinden fokuserar på problem som faktiskt introducerades av dina ändringar.

Bästa praxis

Börja konservativt

Om du är ny på commit-grindar, börja med INFO-nivå och öka gradvis strängheten när ditt team blir bekvämt med processen. Detta hjälper till att undvika frustration från överdrivet aggressiv blockering.

Granska blockerade commits

När en commit blockeras, ta dig tid att granska resultaten. Även om du beslutar att fortsätta hjälper det att förstå varför den flaggades dig att lära och förbättra din kodkvalitet.

Använd överskrivning rimligt

Möjligheten att överskriva en blockeringsrekommendation är viktig för flexibilitet, men använd den eftertänksamt. Om du ofta överskriver blockeringar, överväg om din grindnivå är för strikt eller om det finns mönster i din kod som behöver åtgärdas.

Teamkommunikation

Se till att ditt team förstår hur commit-grinden fungerar och varför vissa commits blockeras. Detta hjälper till att bygga förtroende för systemet och säkerställer att alla är anpassade till kodkvalitetsstandarder.

Slutsats

Commit-grinden är ett kraftfullt verktyg för att upprätthålla kodkvalitet och säkerhet, men den är mest effektiv när den är konfigurerad lämpligt för ditt teams behov. Genom att förstå hur den vägda poängsättningen fungerar och välja rätt allvarlighetsnivå kan du skapa ett effektivt säkerhetsnät som fångar problem utan att bli en flaskhals.

Kom ihåg, grinden är där för att hjälpa, inte för att hindra. Använd den som ett verktyg för att förbättra kodkvalitet samtidigt som du behåller utvecklarproduktiviteten. Med korrekt konfiguration och teamstöd blir commit-grinden en ovärderlig del av ditt utvecklingsarbetsflöde.

Redo att sätta upp din commit-grind? Installera AI Diff Review och börja skydda din kodbas idag.