Vad är en changelog?
En changelog är en detaljerad registrering av ändringar som gjorts i ett projekt, ofta inklusive fixar och nya funktioner. Varje fil eller dokument i ett projekt kan innehålla en egen logg över ändringar, förutom en masterprojektlogg. En changelog består vanligtvis av en kronologisk lista med detaljer som har gjorts och vem som har gjort dem. Changelogs används av utvecklare för att skapa och underhålla programvara, hårdvara, webb och dokumentation.
Changelog-filer är vanligtvis organiserade i stycken som beskriver alla förändringar förknippade med ett specifikt mål. Varje stycke börjar ofta med ändringsdatum, författarens namn och e-postadress. Namnet på varje ändrad fil listas tillsammans med funktionen eller avsnittet som har ändrats. Ofta ges också en kort anledning med några detaljer om förändringen. Changelogs är viktiga i projekt som involverar många utvecklare över tid, till exempel open source-programvara.
Ändringar av programvaruprojekt kan också loggas automatiskt med ett kontrollsystem för källkodrevision. Dessa system spårar vanligtvis ändringar som gjorts i kod- och projektfiler för att effektivt kunna bygga om programvara under utveckling. De behåller sina egna interna changelog-filer och kan generera mänskliga läsbara poster av alla filer som har ändrats. Dessa system inkluderar ofta automatiskt specialmarkerade kommentarer från kodfilerna i sina ändringsrapporter. Detta gör att en användbar post av specifika källkodförändringar kan upprätthållas.
Ett dokumentationsprojekt kan också innehålla changelog-filer eller helt enkelt en lista över revideringar i huvuddokumentet. Ordbehandlare inkluderar ofta en ändringsspårningsmekanism som indikerar varje ändring som gjorts, ner till det sista tecknet. Däremot kan en dokumentändring ge en mer generell nivå för revisionsspårning. Vissa dokumentationsverktyg kan skapa och underhålla denna information automatiskt. De kan be författaren om information om ändringar och inkludera den i ett avsnitt av dokumentet eller förvara den i en separat fil.
Datormaskinvaruprojekt kan använda changelog-filer för att spåra ändringar av scheman, diagram och simulatorfiler. Loggar används också av webbdesigners för att spåra webbplatsändringar och kodändringar. Projektledningsinsatser av alla slag kan också dra nytta av modifieringsregister. En changelog är användbar i alla projekt där det kan vara viktigt att förstå hur tidigare versioner skiljer sig från det nuvarande.
Släppanteckningar är vanligtvis baserade på projektändringar, men fokuserar ofta på bugfixar och produktförbättringar. De skrivs ofta på en mer allmän nivå och kan diskutera effekterna av förändringarna på produktanvändare. De kan också innehålla instruktioner för att skapa specifika problem och beskriva tester som utförts för att verifiera korrigeringarna. I allmänhet adresserar release-anteckningar produktfunktionalitet snarare än individuella ändringar av specifika produktfiler.