Ga naar hoofdinhoud

GitHub-integratie

Overzicht van de GitHub-integratie​

SEW ondersteunt momenteel integratie met GitHub, waarmee u uw GitHub-account en -repository's rechtstreeks aan het platform kunt koppelen. Via deze verbinding kan GitHub dienen als een lokale, versiebeheerde repository die gesynchroniseerd blijft met de SEW-repository. Beheerders kunnen authenticatie configureren, repository's selecteren en synchronisatie-instellingen beheren — zo kunnen teams hun vertrouwde GitHub-workflows behouden en tegelijkertijd profiteren van het gecentraliseerde projectbeheer en de automatiseringsmogelijkheden van SEW.

Belangrijkste kenmerken van de integratie​

Het integreren van GitHub met SEW biedt verschillende voordelen:

  • Gestroomlijnde workflow: Integreert het robuuste versiebeheer van GitHub naadloos met de PLC-projectversiebeheer- en PLC-beheerfuncties van SEW, wat de samenwerking binnen het team verbetert.
  • Gecentraliseerd beheer: Combineer coderepository's en PLC-projectbeheer in één platform om administratie en toegangsbeheer te vereenvoudigen.
  • Automatisering en implementatie: Maak gebruik van de pipelines van SEW voor geautomatiseerde implementatiefuncties, zodat projectreleases rechtstreeks vanuit GitHub-repository's worden gestroomlijnd.
  • Realtime samenwerking: Updates en wijzigingen worden direct gesynchroniseerd, zodat alle teamleden met de nieuwste projectversie werken.

Door GitHub te integreren met SEW kan uw team de productiviteit en projectefficiëntie verhogen.

SEW verbinden met GitHub​

GitHub configureren voor SEW-integratie​

  1. Log in bij GitHub: Zorg dat u uw GitHub-inloggegevens bij de hand hebt.
  2. Genereer een Personal Access Token: Ga naar Developer settings om SEW toegang te verlenen, kies Personal access tokens en maak een nieuw Fine-grained token aan. Stel de rechten in op Contents en Metadata voor de repository's die u wilt delen.
  3. Kopieer het token: Bewaar uw token veilig, want het wordt gebruikt tijdens het authenticatieproces in SEW.

Door deze voorbereidende stappen te volgen, is uw GitHub-account klaar voor integratie met SEW, zodat u kunt profiteren van betere samenwerking en projectbeheer.

Uw GitHub koppelen aan uw SEW-account​

Volg deze stappen om uw SEW-platform met GitHub te verbinden:

  1. Open de instellingen: Ga naar het SEW-platform en navigeer naar het gedeelte 'General Settings'.
  2. Maak een nieuwe integratie aan: Ga naar het gedeelte Integrations en voeg een nieuwe integratie toe door op Add Integration te klikken.
  3. Authenticeer het GitHub-account: Voer in het venster Add Integration de naam van de integratie in en plak uw GitHub-toegangstoken.

Webhooks configureren voor automatische updates​

Om automatische updates mogelijk te maken en ervoor te zorgen dat SEW tijdig op de hoogte is van wijzigingen, moet u webhooks effectief instellen binnen uw GitHub-repository's. Zo configureert u deze functie:

  1. Open de repository-instellingen:

    • Navigeer eerst naar uw GitHub-repository.
    • Klik op het tabblad "Settings", dat zich doorgaans uiterst rechts in de navigatiebalk van de repository bevindt.

  2. Zoek het gedeelte Webhooks:

    • Scroll in de instellingen omlaag of zoek naar de optie "Webhooks" in het menu aan de linkerkant.
    • Klik op "Webhooks" om hooks te beheren en nieuwe toe te voegen.

  3. Maak een nieuwe webhook aan:

    • Klik op de knop "Add webhook" om het instellen van een nieuwe webhook te starten.
    • U wordt gevraagd een Payload URL in te voeren; dit is het eindpunt waarnaar u HTTP POST-verzoeken wilt sturen wanneer bepaalde gebeurtenissen plaatsvinden. U kunt deze waarde kopiëren uit uw zojuist aangemaakte integratie.

  4. Configureer de webhook-payload:

    • Kies onder "Content type" de optie application/json om er zeker van te zijn dat u gegevens in een gestructureerd formaat ontvangt.
    • Stel de geheime sleutel in om uw webhook te beveiligen tegen ongeautoriseerde toegang. U kunt deze waarde kopiëren uit uw SEW-integratie.

  5. Selecteer gebeurtenissen:

    • Kies de optie "Just push events".

  6. Rond de instelling af:

    • Controleer de configuraties nogmaals.
    • Klik op "Add webhook" om de webhook af te ronden en te activeren.

Zodra deze is geconfigureerd, stuurt uw webhook updates naar SEW.

Een repository koppelen aan een SEW-project​

Volg deze stappen om een repository aan een SEW-project te koppelen:

  1. Open het projectgedeelte: Open uw SEW-project.

  2. Open het bewerkingsmenu van het project: Klik op de drie puntjes rechtsboven op de projectpagina.

  3. Koppel de repository:

    • Selecteer 'Link to Repository'.
    • Kies een repository uit de lijst om te koppelen.

  4. Bevestiging: Controleer of de configuratie werkt. Bij succes ziet u een GitHub-pictogram in de header met projectdetails.

Uw repository voorbereiden op SEW-integratie​

Nu uw repository is geconfigureerd en verbonden, bereidt u de inhoud ervan voor zodat SEW weet hoe deze moet worden verwerkt.

Mappenstructuur van de GitHub-repository​

Het SEW-integratieproces vereist dat elke repository één enkel PLC-project bevat. Hoewel de mappenstructuur door de gebruiker kan worden aangepast, moet de hoofdmap een config.sda.json-bestand bevatten. Dit bestand specificeert de leverancier en de IDE-versie van het PLC-project.

Schema van het configuratiebestand

  • schema_version: Geeft de versie van het schema van het configuratiebestand aan. De standaardwaarde is 1.0.0, wat toekomstige uitbreidingen ondersteunt en achterwaartse compatibiliteit behoudt.
  • vendor: Specificeert de leverancier van het PLC-project. Toegestane waarden zijn:
    • siemens
    • rockwell
  • ide_version: Specificeert de versie van het PLC-project. Het volgt het formaat {major}.{minor}.{patch}. Zo vertaalt Siemens TIA V17 zich naar 17.0.0 en wordt Rockwell V37 weergegeven als 37.0.0.
  • project_path: Dit veld specificeert het juiste pad naar het PLC-project binnen uw repository. Het gebruikt een relatief padformaat dat begint vanaf de hoofdmap van de repository. Dit betekent dat u bij het instellen van project_path de hoofdmap zelf niet in uw pad moet opnemen. Geef in plaats daarvan de padsegmenten op die naar de specifieke PLC-projectmap leiden. Als uw PLC-project zich bijvoorbeeld bevindt in een map met de naam Projects die direct in de hoofdmap staat, en zich binnen Projects verder een map PLC1 bevindt waarin de gewenste projectbestanden worden bewaard, dan zou uw project_path ./Projects/PLC1/MySiemensPLCProject.zap17 zijn. Deze opzet helpt bij het consistent houden van bestandsverwijzingen in verschillende omgevingen waarin de repository kan worden gebruikt, omdat er geen absolute paden worden gebruikt die per systeem kunnen verschillen.
    • Siemens PLC-project: Voor het beheren van Siemens PLC-projecten bieden wij ondersteuning voor zowel het gecomprimeerde .zap-bestand als de niet-gecomprimeerde mappenstructuur met .ap-bestanden. Zo kunt u met deze formaten werken:
      • Gecomprimeerd bestand: Als u uw project in een gecomprimeerd formaat hebt, kunt u het .zap-bestand rechtstreeks gebruiken. Dit is handig om projecten eenvoudig als één pakket over te dragen. Gebruik bijvoorbeeld het bestandspad:
        • ./Projects/PLC1/MySiemensPLCProject.zap17
        • ./MySiemensPLCProject.zap19
      • Niet-gecomprimeerde map: Als alternatief kunt u werken met een niet-gecomprimeerde map die de .ap-bestanden bevat. Deze opzet maakt eenvoudiger toegang tot afzonderlijke projectcomponenten mogelijk, wat nuttig kan zijn tijdens ontwikkeling of debugging. Gebruik het volgende pad om toegang te krijgen tot uw project:
        • ./Projects/PLC1/MySiemensPLCProject/MySiemensPLCProject.ap17
        • ./MySiemensPLCProject/MySiemensPLCProject.ap19
    • Rockwell PLC-project: Voor Rockwell PLC-projecten is het proces gestroomlijnd. Deze projecten zijn ondergebracht in één enkel .ACD-bestand, wat projectbeheer en -deling vereenvoudigt. Volg deze stappen om toegang te krijgen tot uw Rockwell PLC-project:
      • ACD-bestand: Het .ACD-bestand bevat alle benodigde projectgegevens. Verwijs eenvoudigweg naar het bestand:
        • ./Projects/PLC1/MyRockwellPLCProject.ACD
        • ./MyRockwellPLCProject.ACD

Voorbeeld van een config.sda.json-bestand​

{
    "schema_version": "1.0.0",
    "vendor": "siemens",
    "ide_version": "17.0.0",
    "project_path": "./SimulatedAxisSinamicsV90_S71212C.zap17"
}

Na succesvolle afronding is uw repository gekoppeld aan het SEW-project, wat betere samenwerking en projectbeheer mogelijk maakt. Vanaf nu maakt elke nieuwe commit die naar uw GitHub-repository wordt gepusht een overeenkomstige projectversie aan in uw SEW-project.