Innehållsförteckning

1 Inledning

Lathundarna är skrivna för GitHub:s användargränssnitt. Respektive aktivitet kan dock även genomföras via kommandotolken. Erfarna GitHub-användare kan bortse ifrån lathundarna.

2 Skapa en ny organisation

Kolla om det finns en GitHub-organisation för den aktören som du tillhör.

Om det inte finns, skapa en ny organisation genom att följa anvisningen på Creating a new organization from scratch - GitHub Docs som är en generell beskrivning på hur man skapa en organisation i GitHub.

Välj teamplan som passar din organisation (gratisvarianten brukar funka fint)
Ange information om organisationen, se skärmdump nedan
- Välj ett namn
- Ange mejladress till en kontaktperson
- Välj “A business or institution”

Lägg till medlemmar i organisationen (medlemmarna behöver ha ett GitHub-konto för att kunna läggas till).

3 Skapa ett nytt team

Skapa ett nytt team genom att följa anvisningen på Creating a team - GitHub Docs som är en generell beskrivning på hur man skapa ett team i GitHub.

4 Skapa ett nytt repository

Skapa ett nytt repository genom att följa anvisningen på Creating a new repository - GitHub Docs som är en generell beskrivning på hur man skapa ett repository i GitHub.

När repositoryt är skapat kan man lägga till medlemmar eller team som ska vara med i arbetet kring repositoryt. Detta görs antingen direkt i anslutning till att repositoryt har skapats eller senare genom att gå in till repositoryt, välja “Settings”, välja “Collaborators and teams” och sedan “Add people” eller “Add teams”.

4.1 Hantera inställningar för ett repository

Att hantera inställningar för ett repository kräver att du har admin-rättigheter för repository:t. Om du har admin-rättigheter kan du t.ex. lägga till eller redigera medlemmar och hantera deras behörigheter.

För att lägga till en ny medlem i repository:t följ nedanstående steg

Välj Settings > Collaborators and teams
Under Collaborators and teams, välj Add people (du behöver personens GitHub namn eller den mejladress som de har kopplat till sitt GitHub-konto)
Välj sedan vilken behörighet de ska få och klicka på Add selection

5 Skapa en ny fork

På Fork a repo - GitHub Docs finns en generell beskrivning på hur man skapa en fork. Nedan följer en beskrivning som är specifik för att skapa en fork från modellbibliotek/CKM Mirror

Navigera till modellbibliotek/CKM Mirror
Navigera till övre höger hörn, klicka på pilen bredvid “Fork” och välj “Create a new fork”

Fyll i uppgifterna om forken som ska skapas
- Ange Owner (t.ex. namn på region eller leverantör som “Region Östergötland” eller “TietoEvry”, krävs att de är tillagda som GitHub organisation, se Skapa en ny organisation )
- Ange Repository name (dvs. CKM-mirror-via-modellbibliotek)
- Fyll i en beskrivning av forken under Description

6 Synka en fork

Synka en fork genom att följa anvisningen på Syncing a fork - GitHub Docs som är en generell beskrivning på hur man uppdatera en fork i GitHub.

Observera! För att enbart få med uppdateringar från uppstream-repository:t välj “Update branch”.

7 Visa befintliga brancher

Visa befintliga brancher genom att följa anvisningen på Viewing branches in your repository - GitHub Docs som är en generell beskrivning på hur man visar brancher i GitHub.

8 Skapa en ny branch

Skapa en ny branch genom att följa anvisningen på Creating and deleting branches within your repository - GitHub Docs som är en generell beskrivning på hur man skapa en branch i GitHub.

Följ anvisningar i Namnge en branch vid namngivning av branchen.

Under “Branch source”, välj vilket repository och vilken branch som den nya branchen ska skapas ifrån. I nedanstående skärmdump skapas den nya branchen “test” från masterbranchen i repositoryt modellbibliotek/CKM Mirror.

9 Namnge branch

Här listas allmänna rekommendationer för att namnge en branch

Döp branchen till “xyz” där xyz är en valfri text utan mellanslag som beskriver området som branchen avser
Använd gemener (små bokstäver)
Använd engelska (därmed ska inga å, ä eller ö ingå i namnet)
Om namnet innehåller flera ord bindas de ihop med bindestreck

Exempel på namn är “chemotherapy-symptoms” eller “laboratory-medicine”.

10 Döpa om en branch

Döpa om en branch genom att följa anvisningen på Renaming a branch - GitHub Docs som är en generell beskrivning på hur man döper om brancher i GitHub.

11 Lägg till en fil

Lägg till en fil i en branch i ett repository genom att följa anvisningen i Adding a file to a repository - GitHub Docs som är en generell beskrivning på hur man lägger till filer i GitHub.

OBS! Du behöver gå till branchen och till det stället i dess mappstruktur där du vill att filen ska skapas. I skärmdumparna nedan kommer filen exempelvis skapas i branchen “UMI-warning-info” under mappen “local”. När du har klickat på “Add file” kan du antingen välja att skapa en helt ny fil eller att ladda upp en fil, välj det som är aktuellt för dig. Ge en nyskapad fil ett namn, fyll på med information och klicka på “Commit changes”.

12 Ta bort filer i en branch

Filer kan tas bort på olika sätt. Nedan förklaras hur man ta bort en fil genom att använda github.dev

12.1 Via github.dev

Öppna filen som du vill ta bort, (nedanstående skrämdumpar är tagna med README-filen som exempelfil)
När filen har öppnats, klicka på pilen till höger och sedan välj “github.dev”
Markera filen i hierarkin till vänster och klicka på “Delete” på ditt tangentbord
Efter att ha klickat “Delete” behöver du bekräfta borttagning genom att klicka “Delete” igen i en pop-up
När du har tagit bort filen behöver du committa och pusha dina ändringarna till repositoryt (än så länge har alla dina ändringar enbart skett lokalt). Till vänster i menyn kommer det dyka upp en liten 1:a vid gulmarkerade symbolen för Source control. Kicka på symbolen och fyll i ett meddelande som beskriver förändringen som du har gjort. Klicka sedan på “Commit & Push”

13 Committa ändringar till en branch

Ändringar kan committas på olika sätt. Nedan förklaras hur man committa via Archetype Designer eller direkt via GitHub men det kan finnas flera andra sätt.

13.1 Via Archetype Designer

För att committa ändringar via Archetype Designer följ nedanstående steg:

Öppna arketypen eller templaten som du arbetar med i ditt Archetype Designer-repository (och som är kopplat till en GitHub-branch, se Koppla GitHub branch till Archetype Designer repository .
Välj “Save”
Fyll i information i pop-up rutan, inkl. en commit message och välj “Save”, se skärmdump nedan.

Committen kommer synas i branchen i GitHub, se skärmdump nedan.

13.2 Via GitHub

Commit via GitHub kan ske på olika sätt. För att committa småändringar via GitHub följ nedanstående steg:

Gå till branchen där en fil ska ändras
Gå till filen
Välj “Edit”

14 Skapa mapp

Skapa en mapp i en branch i ett repository genom att följa anvisningen i kommentaren på Add a folder · community · Discussion #22534 (github.com).

15 Merga brancher

Merga två brancher genom att följa anvisningen på Creating and deleting branches within your repository - GitHub Docs som är en generell beskrivning på hur man merga brancher i GitHub.

16 Ta bort branch

Ta bort en branch genom att följa anvisningen Creating and deleting branches within your repository - GitHub Docs på som är en generell beskrivning på hur man tar bort en branch i GitHub.

17 Gör en release

I Release-hantering för openEHR-templates - openEHR Sweden - Confluence (atlassian.net) beskrivs hur en release av en template ska göras.

18 Säkerhet

Det finns ett antal sätt att säkra sina brancher, resp. repositoryn i GitHub. Nedan finns några förslag.

18.1 Skydda en branch

Det går att skydda en branch på olika sätt vilket finns beskrivit på About protected branches - GitHub Docs som är en generell beskrivning på hur man skyddar brancher i GitHub.

18.2 Använd filen CODEOWNERS

Du kan använda en CODEOWNERS-fil för att definiera individer eller team som är ansvariga för kod (eller annat innehåll) i ett repository. “Kodägare” blir automatiskt tillfrågade om granskning när någon öppnar en pull request som ändrar kod som de äger. Följ About code owners - GitHub Docs för att få mer information om vad en CODEOWNERS-fil är, samt hur den skapas.

För ett exempel, se hur det är uppsatt inom Region Stockholm: CKM-mirror-via-modellbibliotek/.github/CODEOWNERS at master · regionstockholm/CKM-mirror-via-modellbibliotek

openEHR Sweden

GitHub-lathundar