Ugrás a fő tartalomhoz

GitHub-integráció

A GitHub-integráció áttekintése​

A SEW jelenleg támogatja a GitHub integrációt, amely lehetővé teszi, hogy GitHub-fiókját és -tárolóit közvetlenül a platformhoz kapcsolja. Ezen a kapcsolaton keresztül a GitHub helyi, verziókövetett tárolóként szolgálhat, amely szinkronban marad a SEW tárolóval. Az adminisztrátorok konfigurálhatják a hitelesítést, kiválaszthatják a tárolókat és kezelhetik a szinkronizálási beállításokat – így a csapatok megtarthatják a megszokott GitHub-munkafolyamatokat, miközben élvezhetik a SEW központosított projektmenedzsment- és automatizálási képességeinek előnyeit.

Az integráció fő jellemzői​

A GitHub és a SEW integrációja számos előnyt kínál:

  • Egyszerűsített munkafolyamat: Zökkenőmentesen integrálja a GitHub robusztus verziókezelését a SEW PLC-projektverziózási és PLC-kezelési funkcióival, elősegítve a csapatmunkát.
  • Központosított kezelés: Egyesítse a kódtárolókat és a PLC-projektek kezelését egyetlen platformon az adminisztráció és a hozzáférés-kezelés egyszerűsítése érdekében.
  • Automatizálás és telepítés: Használja a SEW pipelines automatizált telepítési funkcióit, hogy a projektkiadásokat közvetlenül a GitHub-tárolókból egyszerűsítse.
  • Valós idejű együttműködés: Az azonnali frissítések és módosítások szinkronizálódnak, így minden csapattag a legfrissebb projektverzióval dolgozik.

A GitHub és a SEW integrációjával csapata növelheti a termelékenységet és a projekthatékonyságot.

Hogyan kapcsolható a SEW a GitHubhoz​

A GitHub konfigurálása a SEW-integrációhoz​

  1. Jelentkezzen be a GitHubra: Győződjön meg róla, hogy rendelkezésre állnak GitHub-hitelesítő adatai.
  2. Személyes hozzáférési token létrehozása: A SEW hozzáférésének biztosításához nyissa meg a Developer settings menüt, válassza a Personal access tokens lehetőséget, és hozzon létre egy új Fine-grained tokent. Állítsa be a jogosultságokat Contents és Metadata értékre azoknál a tárolóknál, amelyeket meg szeretne osztani.
  3. Token másolása: Tárolja a tokent biztonságos helyen, mivel a SEW-ben a hitelesítési folyamat során szükség lesz rá.

Ezeket az előkészítő lépéseket követve GitHub-fiókja készen áll a SEW-vel való integrációra, így élvezheti a fejlettebb együttműködés és projektmenedzsment előnyeit.

A GitHub összekapcsolása a SEW-fiókjával​

A SEW platform GitHubhoz való kapcsolásához kövesse az alábbi lépéseket:

  1. Beállítások megnyitása: Nyissa meg a SEW platformot, és lépjen a „General Settings” szakaszba.
  2. Új integráció létrehozása: Lépjen az Integrations szakaszba, és adjon hozzá egy új integrációt az Add Integration gombra kattintva.
  3. GitHub-fiók hitelesítése: Az Add Integration ablakban adja meg az integráció nevét, és illessze be a GitHub hozzáférési tokenjét.

Webhookok konfigurálása az automatikus frissítésekhez​

Az automatikus frissítések engedélyezéséhez és annak biztosításához, hogy a SEW azonnal értesüljön a változásokról, hatékonyan kell beállítania a webhookokat a GitHub-tárolókban. Így konfigurálhatja ezt a funkciót:

  1. A tároló beállításainak megnyitása:

    • Először navigáljon a GitHub-tárolójához.
    • Kattintson a „Settings” fülre, amely általában a tároló navigációs sávjának jobb szélén található.

  2. A Webhooks szakasz megkeresése:

    • A beállításokban görgessen lejjebb, vagy keresse meg a „Webhooks” lehetőséget a bal oldali menüben.
    • Kattintson a „Webhooks” elemre a hookok kezeléséhez és új hozzáadásához.

  3. Új webhook létrehozása:

    • Nyomja meg az „Add webhook” gombot az új webhook beállításának megkezdéséhez.
    • A rendszer megkéri, hogy adjon meg egy Payload URL-t, amely az a végpont, ahová bizonyos események bekövetkezésekor HTTP POST kéréseket kíván küldeni. Ezt az értéket az újonnan létrehozott integrációból másolhatja ki.

  4. A webhook payload konfigurálása:

    • A „Content type” alatt válassza az application/json értéket, hogy strukturált formátumban kapja meg az adatokat.
    • Állítsa be a titkos kulcsot, hogy megvédje webhookját az illetéktelen hozzáféréstől. Ezt az értéket a SEW-integrációból másolhatja ki.

  5. Események kiválasztása:

    • Válassza a „Just push events” lehetőséget.

  6. Beállítás véglegesítése:

    • Ellenőrizze még egyszer a konfigurációt.
    • Kattintson az „Add webhook” gombra a véglegesítéshez és a webhook aktiválásához.

A konfigurálást követően a webhook frissítéseket fog küldeni a SEW-nek.

Tároló összekapcsolása egy SEW-projekttel​

Egy tároló SEW-projekthez való kapcsolásához kövesse az alábbi lépéseket:

  1. A projekt szakasz megnyitása: Nyissa meg a SEW-projektjét.

  2. A projekt szerkesztési menüjének megnyitása: Válassza ki a három pontot a projekt oldalának jobb felső sarkában.

  3. Tároló összekapcsolása:

    • Válassza a „Link to Repository” lehetőséget.
    • Válasszon ki egy tárolót a listából az összekapcsoláshoz.

  4. Megerősítés: Ellenőrizze, hogy a beállítás működik-e. Sikeres esetben egy GitHub ikon jelenik meg a projekt részleteinek fejlécében.

A tároló előkészítése a SEW-integrációhoz​

Most, hogy tárolója konfigurálva és összekapcsolva van, készítse elő a tartalmát, hogy a SEW értelmezni tudja, hogyan kezelje azt.

A GitHub-tároló mappaszerkezete​

A SEW-integrációs folyamat megköveteli, hogy minden tároló egyetlen PLC-projektet tartalmazzon. Bár a mappaszerkezet a felhasználó által testreszabható, a gyökérmappának tartalmaznia kell egy config.sda.json fájlt. Ez a fájl határozza meg a PLC-projekt gyártóját és IDE-verzióját.

A konfigurációs fájl sémája

  • schema_version: A konfigurációs fájl sémájának verzióját jelzi. Az alapértelmezett érték 1.0.0, amely támogatja a jövőbeli fejlesztéseket és biztosítja a visszamenőleges kompatibilitást.
  • vendor: A PLC-projekt gyártóját adja meg. Elfogadott értékek:
    • siemens
    • rockwell
  • ide_version: A PLC-projekt verzióját adja meg. Formátuma {major}.{minor}.{patch}. Például a Siemens TIA V17 esetén 17.0.0, a Rockwell V37 esetén pedig 37.0.0.
  • project_path: Ez a mező adja meg a PLC-projekt helyes elérési útját a tárolón belül. Relatív elérési út formátumot használ, amely a tároló gyökérmappájából indul. Ez azt jelenti, hogy a project_path beállításakor magát a gyökérkönyvtárat nem kell szerepeltetni az elérési útban. Ehelyett adja meg az adott PLC-projekt mappájához vezető útvonalszakaszokat. Például, ha a PLC-projektje egy Projects nevű mappában található, amely közvetlenül a gyökérkönyvtárban van, és a Projects mappán belül van egy PLC1 mappa, ahol a kívánt projektfájlokat tartják, akkor a project_path értéke ./Projects/PLC1/MySiemensPLCProject.zap17 lesz. Ez a beállítás segít a következetes fájlhivatkozás megőrzésében a különböző környezetekben, ahol a tárolót használhatják, mivel nem támaszkodik rendszerenként eltérő absztrakt (absolute) elérési utakra.
    • Siemens PLC-projekt: A Siemens PLC-projektek kezeléséhez támogatjuk mind a tömörített .zap fájlt, mind a .ap fájlokat tartalmazó tömörítetlen mappaszerkezetet. Így dolgozhat ezekkel a formátumokkal:
      • Tömörített fájl: Ha a projekt tömörített formátumban áll rendelkezésre, közvetlenül használhatja a .zap fájlt. Ez akkor hasznos, ha a projekteket egyetlen csomagként szeretné könnyen továbbítani. Például használja a következő fájlútvonalat:
        • ./Projects/PLC1/MySiemensPLCProject.zap17
        • ./MySiemensPLCProject.zap19
      • Tömörítetlen mappa: Alternatívaként dolgozhat egy tömörítetlen mappával, amely a .ap fájlokat tartalmazza. Ez a felállás könnyebb hozzáférést biztosít az egyes projektkomponensekhez, ami előnyös lehet a fejlesztés vagy a hibakeresés során. A projekt eléréséhez használja a következő útvonalat:
        • ./Projects/PLC1/MySiemensPLCProject/MySiemensPLCProject.ap17
        • ./MySiemensPLCProject/MySiemensPLCProject.ap19
    • Rockwell PLC-projekt: A Rockwell PLC-projektek esetén a folyamat egyszerűbb. Ezek a projektek egyetlen .ACD fájlba vannak beágyazva, ami egyszerűsíti a projektkezelést és -megosztást. A Rockwell PLC-projekt eléréséhez kövesse az alábbi lépéseket:
      • ACD-fájl: A .ACD fájl az összes szükséges projektadatot tartalmazza. Egyszerűen hivatkozzon a fájlra:
        • ./Projects/PLC1/MyRockwellPLCProject.ACD
        • ./MyRockwellPLCProject.ACD

Példa egy config.sda.json fájlra​

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

Sikeres befejezés után a tároló összekapcsolódik a SEW-projekttel, elősegítve a jobb együttműködést és projektmenedzsmentet. Ettől kezdve a GitHub-tárolóba küldött minden új commit egy megfelelő projektverziót hoz létre a SEW-projektben.