Versiebeheersing Onder de Knie: Praktische Gids voor Git en GitHub voor Ontwikkelaars

Het leven van een programmeur is al moeilijk genoeg. Waarom uw leven niet makkelijker maken en het versiebeheer van uw projecten uitbesteden aan speciale diensten? De meeste programmeurs in de IT-wereld zijn bekend met Git, maar voor sommige OT-programmeurs in deze community is dit een heel nieuw concept. Als u met verschillende collega's aan hetzelfde project werkt, wordt het delen van code nog meer een gedoe, een service als GitHub maakt het gemakkelijk om samen te werken aan dezelfde code. Deze blog begeleidt u door uw eerste stappen in het gebruik van Git en GitHub om uw code en projecten in orde te houden.

In deze blog gebruik ik GitHub en de GitHub-client voor Windows, maar let op dat er meer opties zijn, inclusief GitLab. Ik hou gewoon van de gebruiksgemak van de GitHub-client!

Een Repository Opzetten op GitHub

Stap 1 – GitHub Client voor Windows Downloaden en Installeren

Eigenlijk zou de eerste stap het aanmaken van een GitHub-account zijn, maar dat valt een beetje buiten de scope van deze blog.

1. De client kan gedownload worden hier.
2. Volg de Installatiegids
3. Log in op uw GitHub-account

Stap 2 – Een Map of Repository Aanmaken voor Uw Project

Een repository is een plek voor uw project om te leven. Maak één map voor elk project! Elke keer als er iets verandert in deze map, zal de GitHub-client het detecteren en zult u in staat zijn uw wijzigingen op te slaan of te pushen naar de online repository op GitHub.

1. Klik op "Create a New Repository on your hard drive …"
2. Geef uw nieuwe repository een naam en beschrijving.
3. U kunt het pad voor de repository wijzigen als u wilt, of het laten (de lui manier)
4. Klik op "Initialize this repository with a README" (Lui betekent niet dat u geen best practices volgt en uw code documenteert!)
5. Maak de repository aan

Stap 3 – Een PLCnext Project Aanmaken

Git werkt geweldig met tekst-gebaseerde bestanden. Gelukkig is er in PLCnext Engineer een optie om uw project op te slaan als een heel aantal tekstbestanden, perfect voor Git en dus voor onze GitHub-client!

1. Open PLCnext Engineer en begin met het aanmaken van een project zoals u gewend bent.
2. Wanneer u klaar bent om uw project op te slaan, kies Save Project As (F12)
3. Blader naar uw GitHub repository (standaard: This PC/documents/GitHub)
4. Sla uw project op als "Uncompressed Project"

Stap 4 – Uw Wijzigingen Committen

Om wijzigingen op te slaan in uw repository, moet u ze committen naar een branch. Wat een branch precies is, leg ik later uit, voor nu hoeft u zich alleen te herinneren dat u uw wijzigingen naar een branch moet committen om ze op te slaan.

Geef uw commit een duidelijke en korte beschrijving, zodat u kunt onthouden wat er precies gewijzigd is!

Stap 5 – Uw Repository Publiceren of Pushen

De laatste stap om een online repository aan te maken is onze lokale repository naar GitHub te pushen. Dit is net zo makkelijk als op een knop drukken of (ctrl + p) indrukken. Kies of uw code privé moet zijn en of het u of een organisatie toebehoort.

Stap 6 – Documenteren!

Druk (Ctrl + shift + G) om de repository online op GitHub in uw browser te bekijken. Voila! Daar is uw PLCnext-project op GitHub. Herinner u zich de "Initialize README"? Dat is de tekst die u nu voor zich ziet. In de README.md moet u de structuur van het project, het doel en misschien enkele contactgegevens voor toekomstige referentie uitleggen.

Maak nu enkele wijzigingen in het README.md-bestand door op het potlood te klikken. Het bestand is "geschreven" in MarkDown, meer informatie over MarkDown vindt u hier.

Als u enkele wijzigingen heeft aangebracht, commit weer naar de master branch!

Stap 7 – Wijzigingen Ophalen naar Uw Lokale Repository

De Windows-client zal detecteren dat er wijzigingen zijn aangebracht in de repository op GitHub. Vergeet niet de wijzigingen op te halen om weer te werken op de nieuwste versie!

Tips & Trucs

Issue Tracker

GitHub heeft een geweldige issue tracker, gebruik hem om bekende problemen in uw software bij te houden en oplossingen te bespreken met de andere stakeholders.

Projects

Gebruik het ingebouwde Project Bord om uw taken bij te houden met een kanban-bord. Als u wilt, kunt u uw kanban automatiseren met ingebouwde triggers om het leven nog makkelijker te maken.

Branches

Aah, hier zijn we. Zie, ik zei dat ik uitlegde wat branches zijn! Nou, ik laat GitHub uitleggen wat branches zijn …

Gaat u veel wijzigingen aanbrengen of een nieuwe functie implementeren? Maak een branch om uw wijzigingen geïsoleerd te houden en voeg uw "feature branch" samen met uw master branch via een pull request.

Release

Klaar om een project te deployen? Maak een release om toe te voegen aan uw AS Build!