Preskočiť na hlavný obsah

Integrácia GitHub

Prehľad integrácie GitHub​

SEW aktuálne podporuje integráciu so službou GitHub, ktorá vám umožňuje prepojiť váš účet a repozitáre GitHub priamo s platformou. Prostredníctvom tohto prepojenia môže GitHub slúžiť ako lokálny repozitár so správou verzií, ktorý zostáva synchronizovaný s repozitárom SEW. Administrátori môžu konfigurovať autentifikáciu, vyberať repozitáre a spravovať nastavenia synchronizácie – vďaka tomu môžu tímy zachovať známe pracovné postupy GitHub a zároveň využívať centralizovanú správu projektov a automatizačné možnosti SEW.

Kľúčové vlastnosti integrácie​

Integrácia GitHub so SEW prináša niekoľko výhod:

  • Zefektívnený pracovný postup: Bezproblémovo spája robustnú správu verzií GitHub s funkciami verzovania PLC projektov a správy PLC v SEW, čím zlepšuje tímovú spoluprácu.
  • Centralizovaná správa: Spojte repozitáre kódu a správu PLC projektov na jednej platforme a zjednodušte tak administráciu a riadenie prístupu.
  • Automatizácia a nasadenie: Využite pipelines v SEW na automatizované nasadzovanie a zjednodušte vydávanie projektov priamo z repozitárov GitHub.
  • Spolupráca v reálnom čase: Okamžité aktualizácie a zmeny sa synchronizujú, čím sa zabezpečí, že všetci členovia tímu pracujú s najnovšou verziou projektu.

Integráciou GitHub so SEW môže váš tím zvýšiť produktivitu a efektivitu projektov.

Ako prepojiť SEW s GitHub​

Konfigurácia GitHub pre integráciu so SEW​

  1. Prihláste sa do GitHub: Uistite sa, že máte pripravené svoje prihlasovacie údaje pre GitHub.
  2. Vygenerujte osobný prístupový token: Aby ste poskytli prístup platforme SEW, prejdite do Developer settings, zvoľte Personal access tokens a vytvorte nový Fine-grained token. Nastavte oprávnenia Contents a Metadata pre repozitáre, ktoré chcete zdieľať.
  3. Skopírujte token: Uložte si token na bezpečnom mieste, keďže sa použije počas procesu autentifikácie v SEW.

Dodržaním týchto prípravných krokov bude váš účet GitHub pripravený na integráciu so SEW, čo vám umožní využívať lepšiu spoluprácu a správu projektov.

Prepojenie účtu GitHub s vaším účtom SEW​

Ak chcete prepojiť platformu SEW s GitHub, postupujte podľa týchto krokov:

  1. Prístup k nastaveniam: Prejdite na platformu SEW a otvorte sekciu „General Settings“.
  2. Vytvorte novú integráciu: Prejdite do sekcie Integrations a pridajte novú integráciu kliknutím na Add Integration.
  3. Autentifikujte účet GitHub: V okne Add Integration zadajte názov integrácie a vložte svoj prístupový token GitHub.

Konfigurácia webhookov pre automatické aktualizácie​

Ak chcete povoliť automatické aktualizácie a zabezpečiť, aby bola SEW okamžite informovaná o zmenách, musíte vo svojich repozitároch GitHub správne nastaviť webhooky. Postupujte takto:

  1. Otvorte nastavenia repozitára:

    • Začnite tým, že prejdete do svojho repozitára GitHub.
    • Kliknite na kartu „Settings“, ktorá sa zvyčajne nachádza úplne vpravo v navigačnej lište repozitára.

  2. Nájdite sekciu Webhooks:

    • Po otvorení nastavení prejdite nadol alebo vyhľadajte možnosť „Webhooks“ v ľavom menu.
    • Kliknutím na „Webhooks“ môžete spravovať a pridávať nové hooky.

  3. Vytvorte nový webhook:

    • Stlačte tlačidlo „Add webhook“ a spustite nastavenie nového webhooku.
    • Budete vyzvaní na zadanie Payload URL, teda koncového bodu, na ktorý chcete odosielať HTTP POST požiadavky pri určitých udalostiach. Túto hodnotu môžete skopírovať z novovytvorenej integrácie.

  4. Nakonfigurujte payload webhooku:

    • V položke „Content type“ zvoľte application/json, aby ste dostávali údaje v štruktúrovanom formáte.
    • Nastavte tajný kľúč (secret) na zabezpečenie webhooku proti neoprávnenému prístupu. Túto hodnotu môžete skopírovať zo svojej integrácie SEW.

  5. Vyberte udalosti:

    • Zvoľte možnosť „Just push events“.

  6. Dokončite nastavenie:

    • Skontrolujte konfiguráciu.
    • Kliknutím na „Add webhook“ nastavenie dokončíte a webhook aktivujete.

Po nakonfigurovaní bude váš webhook odosielať aktualizácie do SEW.

Prepojenie repozitára s projektom SEW​

Ak chcete prepojiť repozitár s projektom SEW, postupujte podľa týchto krokov:

  1. Otvorte sekciu projektu: Otvorte svoj projekt SEW.

  2. Otvorte menu úprav projektu: Kliknite na tri bodky v pravom hornom rohu stránky projektu.

  3. Prepojte repozitár:

    • Zvoľte „Link to Repository“.
    • Zo zoznamu vyberte repozitár, ktorý chcete prepojiť.

  4. Potvrdenie: Overte, či nastavenie funguje. V prípade úspechu uvidíte ikonu GitHub v hlavičke detailov projektu.

Príprava repozitára na integráciu so SEW​

Teraz, keď je váš repozitár nakonfigurovaný a prepojený, pripravte jeho obsah tak, aby SEW dokázala rozpoznať, ako s ním pracovať.

Štruktúra priečinkov repozitára GitHub​

Proces integrácie SEW vyžaduje, aby každý repozitár obsahoval jeden PLC projekt. Hoci si štruktúru priečinkov môže používateľ prispôsobiť, koreňový priečinok musí obsahovať súbor config.sda.json. Tento súbor určuje výrobcu a verziu IDE PLC projektu.

Schéma konfiguračného súboru

  • schema_version: Označuje verziu schémy konfiguračného súboru. Predvolená hodnota je 1.0.0, čo podporuje budúce rozšírenia a zachováva spätnú kompatibilitu.
  • vendor: Určuje výrobcu PLC projektu. Prijímané hodnoty sú:
    • siemens
    • rockwell
  • ide_version: Určuje verziu PLC projektu. Používa formát {major}.{minor}.{patch}. Napríklad Siemens TIA V17 sa prekladá na 17.0.0 a Rockwell V37 sa reprezentuje ako 37.0.0.
  • project_path: Toto pole určuje správnu cestu k PLC projektu v rámci vášho repozitára. Používa formát relatívnej cesty začínajúcej od koreňového priečinka repozitára. To znamená, že pri nastavovaní project_path by ste nemali do cesty zahrnúť samotný koreňový adresár. Namiesto toho uveďte segmenty cesty vedúce ku konkrétnemu priečinku PLC projektu. Napríklad, ak sa váš PLC projekt nachádza v priečinku s názvom Projects, ktorý sa nachádza priamo v koreňovom adresári, a ďalej v priečinku Projects je priečinok PLC1, kde sú uložené požadované súbory projektu, vaša hodnota project_path by bola ./Projects/PLC1/MySiemensPLCProject.zap17. Toto nastavenie pomáha udržiavať konzistentné odkazovanie na súbory v rôznych prostrediach, v ktorých sa repozitár môže používať, keďže nezávisí od absolútnych ciest, ktoré sa môžu medzi systémami líšiť.
    • Siemens PLC projekt: Pri správe projektov Siemens PLC podporujeme ako komprimovaný súbor .zap, tak nekomprimovanú štruktúru priečinkov obsahujúcu súbory .ap. S týmito formátmi môžete pracovať takto:
      • Komprimovaný súbor: Ak máte projekt v komprimovanom formáte, môžete použiť priamo súbor .zap. To je užitočné pri jednoduchom prenose projektov ako jedného balíka. Použite napríklad cestu k súboru:
        • ./Projects/PLC1/MySiemensPLCProject.zap17
        • ./MySiemensPLCProject.zap19
      • Nekomprimovaný priečinok: Prípadne môžete pracovať s nekomprimovaným priečinkom, ktorý obsahuje súbory .ap. Toto nastavenie umožňuje jednoduchší prístup k jednotlivým komponentom projektu, čo môže byť výhodné počas vývoja alebo ladenia. Na prístup k projektu použite nasledujúcu cestu:
        • ./Projects/PLC1/MySiemensPLCProject/MySiemensPLCProject.ap17
        • ./MySiemensPLCProject/MySiemensPLCProject.ap19
    • Rockwell PLC projekt: Pri projektoch Rockwell PLC je proces zjednodušený. Tieto projekty sú zapuzdrené v jedinom súbore .ACD, čo zjednodušuje správu a zdieľanie projektov. Na prístup k projektu Rockwell PLC postupujte takto:
      • Súbor ACD: Súbor .ACD obsahuje všetky potrebné údaje projektu. Jednoducho odkážte na tento súbor:
        • ./Projects/PLC1/MyRockwellPLCProject.ACD
        • ./MyRockwellPLCProject.ACD

Príklad súboru config.sda.json​

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

Po úspešnom dokončení bude váš repozitár prepojený s projektom SEW, čo uľahčí spoluprácu a správu projektu. Odteraz každý nový commit odoslaný do vášho repozitára GitHub vytvorí zodpovedajúcu verziu projektu vo vašom projekte SEW.