Versionshantering

Genom att använda GitLab kan allt material som hanteras och distribueras spåras noggrant. Versionshantering i GitLab gör det möjligt att dokumentera och följa alla ändringar på detaljnivå. Detta innebär att du alltid kan se vem som har gjort vilka ändringar och när de har gjorts.

Versionshanteringen i GitLab använder ett system för semantisk versionshantering, vilket innebär att versionsnumren följer formatet MAJOR.MINOR.PATCH. Detta system hjälper till att förstå omfattningen och betydelsen av ändringar mellan olika versioner:

1. MAJOR: Versionen ökas när det sker stora förändringar som gör att tidigare versioner inte längre är giltiga eller kräver omfattande justeringar för att följa de nya riktlinjerna.
   

   • Exempel: Om en helt ny anvisning läggs till som introducerar ett nytt arbetssätt eller om befintliga anvisningar genomgår stora förändringar som påverkar projektets grundläggande arbetsmetoder, ökas MAJOR-versionen. Om den tidigare versionen var 2.3.5, uppdateras den till 3.0.0.

2. MINOR: Versionen ökas när nytt innehåll införs som är förenligt med tidigare versioner, vilket gör att tidigare riktlinjer fortfarande är giltiga och användbara.
   

   • Exempel: Om en ny sektion eller ett nytt steg läggs till i en befintlig anvisning utan att ändra tidigare riktlinjer, ökas MINOR-versionen. Om den tidigare versionen var 2.3.5, uppdateras den till 2.4.0.

3. PATCH: Versionen ökas när små fel rättas utan att förändra det befintliga innehållet.
   

   • Exempel: Om stavfel, felaktiga referenser eller mindre inkonsekvenser upptäcks och rättas till utan att påverka anvisningarnas struktur eller innebörd, ökas PATCH-versionen. Om den tidigare versionen var 2.3.5, skulle den uppdateras till 2.3.6.

Gitlab

GitLab används för att skapa och hantera olika paket som till exempel Informationskrav, Värdelistor, Metoder och Mallfiler. Vid publicering till Infopack, ett ramverk utvecklat av BIM Alliance, tilldelas varje paket ett unikt versionsnummer. Infopack fungerar som ett centralt nav för förvaltning och distribution av information.

Vid revidering av innehåll i GitLab sker en noggrann granskning och uppdatering av de aktuella paketen. Efter verifiering och godkännande stämplas de reviderade paketen med ett nytt versionsnummer och publiceras till Infopack. Detta säkerställer att alla ändringar är spårbara och att den senaste informationen alltid är tillgänglig.

Genom att använda GitLab tillsammans med Infopack-ramverket säkerställs en effektiv hantering, förvaltning och distribution av information.

Spåra förändringar i Gitlab

Med hjälp av funktionen "Changes" i GitLab kan du enkelt identifiera och granska förändringar. Denna funktion visar en sammanställning av alla ändringar, inklusive tillägg, borttagningar och modifieringar i filer. Funktionerna inkluderar:

• Översikt: Få en snabb översikt över alla förändringar. Text markerad i rött indikerar borttagningar, medan text markerad i grönt visar tillägg.

• Detaljerad granskning: Se exakt vilka rader i filerna som har ändrats, vilket underlättar noggrann granskning.

• Kommentarer: Lägg till kommentarer direkt på specifika ändrade rader för att underlätta diskussion och feedback mellan teammedlemmar.

• Spårbarhet: Se historik över tidigare ändringar, vilket gör det enkelt att förstå varför och hur en viss förändring gjordes.

Release notes

Release notes är en sammanfattning av de ändringar och nyheter som introduceras med varje ny version. De erbjuder en översikt över både uppdaterat och nytt innehåll, vilket ger användarna en tydlig förståelse för vad den aktuella versionen omfattar.

För varje ny version tas det fram en release note som dokumenterar de genomförda ändringarna. Dessa release notes samlar alla ändringar och innehåller länkar till de relevanta ärendena i GitLab, vilket gör det enkelt för användarna att spåra och förstå de specifika uppdateringarna.

Repository

Ett repository är ett digitalt arkiv där källkod, dokumentation, konfigurationsfiler och andra relaterade data för ett projekt lagras. Här är några nyckelfunktioner:

1. **Versionskontroll:** Ett repository spårar ändringar i filerna över tid. Varje ändring, eller "commit", dokumenteras med information om vad som ändrades och vem som gjorde ändringen. Detta gör det möjligt att gå tillbaka till tidigare versioner av filer eller hela projektet.
   

2. **Historik:** Repositoryt innehåller en fullständig historik av alla ändringar som gjorts, vilket gör det enkelt att förstå utvecklingen av projektet, spåra fel, och se hur projektet har utvecklats över tid.
   

3. Brancher: Ett repository kan innehålla flera "brancher" (grenar), som tillåter utvecklare att arbeta på olika funktioner eller experimentella ändringar utan att påverka huvudversionen av projektet. Brancher kan senare slås samman (merge) med huvudgrenen (vanligtvis "main" eller "master").

4. **Samarbete:** Ett repository gör det enkelt för flera personer att samarbeta på samma projekt. Ändringar kan delas och integreras genom att använda pull requests (i GitLab kallade Merge Requests) eller genom att göra "push" och "pull" operationer.
   

Remote och Local: Ett repository kan vara antingen lokalt (på din egen dator) eller remote (på en server som GitLab). En remote repository används för att lagra och dela projekt med andra, medan en lokal repository används för att utveckla och testa koden på din egen maskin.

Forkning

Vad är forking?

Forking är en process där du skapar en kopia av ett befintligt repository. (Ett repository är som ett digitalt arkiv där källkod, dokumentation, konfigurationsfiler och andra relaterad data för ett projekt lagras). Denna kopia är helt separat från originalet och kan ändras oberoende av det ursprungliga projektet.

Arbetsprocess och nytta:

• Arbetsprocess: När du har forkatt ett repository, kan du göra ändringar fritt i din egen kopia. Detta är användbart för att bidra till ett projekt utan att direkt påverka det ursprungliga repositoryt. Du kan arbeta på nya funktioner, buggrättelser, eller experimentera utan risk för att påverka det primära projektet.

• Nytta: Forking är särskilt användbart i där du vill göra ändringar eller förbättringar och senare skicka dina ändringar tillbaka till huvudprojektet genom en Merge Request. Det ger också möjlighet att arbeta med projekt som du inte har direkt skrivbehörighet till, samtidigt som du behåller en tydlig separation mellan dina ändringar och originalet.

Kloning

Vad är cloning?

Kloning är processen där du skapar en lokal kopia av ett repositor. Denna kopia är en exakt avbild av repositoryt på GitLab och innehåller hela historiken och alla filer.

Arbetsprocess och nytta:

• Arbetsprocess: Att klona ett repository gör att du kan arbeta på projektet offline och göra ändringar lokalt. När du är klar med dina ändringar kan du synkronisera dina ändringar tillbaka till GitLab.

• Nytta: Kloning är användbart för att få en fullständig lokal arbetsmiljö för ett projekt. Det gör det också lätt att samarbeta med andra, eftersom du kan göra ändringar, granska dem och sedan synkronisera dina uppdateringar med det centrala repositoryt.

Infopack

Infopack förvaltar all information med versionsnummer och paketerar den för distribution till exempelvis WordPress (Kravportalen).

Nedan presenteras fyra olika paket i infopack för Nationella Riktlinjer.

När du väljer ett paket, till exempel "Metoder", får du tillgång till allt som har publicerats under den valda versionen. Varje paket innehåller detaljerad information om versionerna, vilket gör det enkelt att spåra och förstå uppdateringar över tid.

Jämföra versioner

I ramverket för Nationella Riktlinjers infopack finns en funktion som gör det möjligt att jämföra olika versioner av anvisningar för att se skillnaderna mellan dem.

För att jämföra versioner, följ dessa steg:

1. Gå till infopacket och välj en äldre version av anvisningen, till exempel version 1.0.0 av ”Anvisningar för PDF-handlingar”.
   

2. Välj funktionen ”Jämför fil”.
   

3. Jämför version 1.0.0 mot version 2.0.0 för den aktuella anvisningen.
   

Efter att du har klickat på ”Jämför” kommer du att kunna se skillnaderna mellan de olika versionerna. Ändringar markeras med rött för borttagna delar och grönt för nya tillägg.

Versionsnummer på kravportalen

I kravportalen redovisas aktuell version längst ner på sidan. Detta versionsnummer gäller för hela kravportalen och indikerar den samlade versionen av alla publicerade paket.

Eftersom de olika paketen publiceras vid olika tidpunkter kan de ha olika versionsnummer. Varje uppdatering av ett paket samlas under en specifik version som redovisas på kravportalen. Till exempel kan paketet "Metoder" vara i version 3.0.0, medan paketet "Värdelistor" är i version 2.0.0. När dessa paket uppdateras och publiceras på kravportalen, kommer versionsnumret för kravportalen att reflektera den samlade versionen, till exempel version 4.0.0.

Vid nästa revideringsrunda, om endast paketet "Värdelistor" har ändrats och uppgraderats till version 3.0.0, kommer den samlade versionen på kravportalen att höjas till version 5.0.0.