Siirry pääsisältöön

GitHub-integraatio

GitHub-integraation yleiskatsaus​

SEW tukee tällä hetkellä integraatiota GitHubin kanssa, jonka avulla voit liittää GitHub-tilisi ja -tietovarastosi suoraan alustaan. Tämän yhteyden kautta GitHub voi toimia paikallisena, versionhallittuna tietovarastona, joka pysyy synkronoituna SEW-tietovaraston kanssa. Ylläpitäjät voivat määrittää todennuksen, valita tietovarastot ja hallita synkronointiasetuksia – näin tiimit voivat säilyttää tuttuja GitHub-työnkulkuja ja hyötyä samalla SEW:n keskitetystä projektinhallinnasta ja automaatio-ominaisuuksista.

Integraation keskeiset ominaisuudet​

GitHubin integrointi SEW:n kanssa tarjoaa useita etuja:

  • Sujuvoitettu työnkulku: Yhdistää saumattomasti GitHubin vankan versionhallinnan SEW:n PLC-projektien versiointiin ja PLC-hallinnan ominaisuuksiin, mikä tehostaa tiimityötä.
  • Keskitetty hallinta: Yhdistä koodivarastot ja PLC-projektien hallinta yhdelle alustalle, mikä yksinkertaistaa ylläpitoa ja käyttöoikeuksien hallintaa.
  • Automaatio ja käyttöönotto: Hyödynnä SEW:n pipelines -automatisoituja käyttöönotto-ominaisuuksia projektijulkaisujen sujuvoittamiseksi suoraan GitHub-tietovarastoista.
  • Reaaliaikainen yhteistyö: Päivitykset ja muutokset synkronoidaan välittömästi, jolloin kaikki tiimin jäsenet työskentelevät projektin uusimman version kanssa.

Integroimalla GitHubin SEW:n kanssa tiimisi voi parantaa tuottavuutta ja projektien tehokkuutta.

SEW:n yhdistäminen GitHubiin​

GitHubin määrittäminen SEW-integraatiota varten​

  1. Kirjaudu GitHubiin: Varmista, että GitHub-tunnuksesi ovat valmiina.
  2. Luo henkilökohtainen käyttöoikeustunnus (Personal Access Token): Anna SEW:lle käyttöoikeus siirtymällä kohtaan Developer settings, valitsemalla Personal access tokens ja luomalla uusi Fine-grained token. Aseta oikeudet Contents ja Metadata niille tietovarastoille, jotka haluat jakaa.
  3. Kopioi tunnus: Säilytä tunnus turvallisesti, sillä sitä käytetään SEW:n todennusprosessin aikana.

Näiden valmisteluvaiheiden jälkeen GitHub-tilisi on valmis integroitavaksi SEW:n kanssa, jolloin voit hyötyä tehostetusta yhteistyöstä ja projektinhallinnasta.

GitHubin yhdistäminen SEW-tiliisi​

Yhdistä SEW-alustasi GitHubiin seuraavasti:

  1. Avaa asetukset: Siirry SEW-alustalle ja avaa 'General Settings' -osio.
  2. Luo uusi integraatio: Siirry Integrations-osioon ja lisää uusi integraatio napsauttamalla Add Integration.
  3. Todenna GitHub-tili: Anna Add Integration -ikkunassa integraation nimi ja liitä GitHub-käyttöoikeustunnuksesi.

Webhookien määrittäminen automaattisia päivityksiä varten​

Jotta automaattiset päivitykset toimivat ja SEW saa nopeasti tiedon muutoksista, sinun on määritettävä webhookit GitHub-tietovarastoissasi. Näin määrität tämän ominaisuuden:

  1. Avaa tietovaraston asetukset:

    • Siirry ensin GitHub-tietovarastoosi.
    • Napsauta "Settings"-välilehteä, joka sijaitsee tavallisesti tietovaraston navigointipalkin oikeassa reunassa.

  2. Etsi Webhooks-osio:

    • Kun olet asetuksissa, vieritä alaspäin tai etsi vasemmanpuoleisesta valikosta "Webhooks"-vaihtoehto.
    • Napsauta "Webhooks" hallitaksesi ja lisätäksesi uusia hookeja.

  3. Luo uusi webhook:

    • Paina "Add webhook" -painiketta aloittaaksesi uuden webhookin määrittämisen.
    • Sinua pyydetään antamaan Payload URL, joka on päätepiste, johon haluat lähettää HTTP POST -pyyntöjä tiettyjen tapahtumien yhteydessä. Voit kopioida tämän arvon juuri luomastasi integraatiosta.

  4. Määritä webhookin hyötykuorma:

    • Valitse kohdassa "Content type" arvo application/json, jotta saat datan jäsennellyssä muodossa.
    • Määritä salainen avain (secret key) suojaamaan webhookiasi luvattomalta käytöltä. Voit kopioida tämän arvon SEW-integraatiostasi.

  5. Valitse tapahtumat:

    • Valitse "Just push events" -vaihtoehto.

  6. Viimeistele määritys:

    • Tarkista asetukset huolellisesti.
    • Napsauta "Add webhook" viimeistelläksesi ja aktivoidaksesi webhookin.

Määrityksen jälkeen webhook lähettää päivitykset SEW:lle.

Tietovaraston liittäminen SEW-projektiin​

Liitä tietovarasto SEW-projektiin seuraavasti:

  1. Avaa projektiosio: Avaa SEW-projektisi.

  2. Avaa projektin muokkausvalikko: Valitse kolme pistettä projektisivun oikeasta ylänurkasta.

  3. Yhdistä tietovarasto:

    • Valitse 'Link to Repository'.
    • Valitse listasta liitettävä tietovarasto.

  4. Vahvistus: Varmista, että määritys toimii. Onnistuessaan näet GitHub-kuvakkeen projektin tietojen otsikkoalueella.

Tietovaraston valmistelu SEW-integraatiota varten​

Nyt kun tietovarastosi on määritetty ja yhdistetty, valmistele sen sisältö niin, että SEW osaa käsitellä sitä.

GitHub-tietovaraston kansiorakenne​

SEW-integraatioprosessi edellyttää, että jokainen tietovarasto sisältää yhden PLC-projektin. Vaikka käyttäjä voi mukauttaa kansiorakennetta, juurikansion on sisällettävä config.sda.json -tiedosto. Tämä tiedosto määrittää PLC-projektin valmistajan ja IDE-version.

Määritystiedoston skeema

  • schema_version: Ilmaisee määritystiedoston skeeman version. Oletusarvo on 1.0.0, joka tukee tulevia laajennuksia ja ylläpitää taaksepäin yhteensopivuutta.
  • vendor: Määrittää PLC-projektin valmistajan. Hyväksytyt arvot ovat:
    • siemens
    • rockwell
  • ide_version: Määrittää PLC-projektin version. Se noudattaa muotoa {major}.{minor}.{patch}. Esimerkiksi Siemens TIA V17 vastaa arvoa 17.0.0 ja Rockwell V37 esitetään muodossa 37.0.0.
  • project_path: Tämä kenttä määrittää oikean polun PLC-projektiin tietovarastossasi. Se käyttää suhteellista polkumuotoa, joka alkaa tietovaraston juurikansiosta. Tämä tarkoittaa, että kun asetat project_path-arvon, sinun ei tule sisällyttää juurihakemistoa itseään polkuun. Anna sen sijaan polun osat, jotka johtavat kyseiseen PLC-projektikansioon. Esimerkiksi jos PLC-projektisi sijaitsee kansiossa nimeltä Projects, joka on suoraan juurihakemistossa, ja Projects-kansion sisällä on PLC1-kansio, jossa halutut projektitiedostot sijaitsevat, project_path-arvo olisi ./Projects/PLC1/MySiemensPLCProject.zap17. Tämä ratkaisu auttaa ylläpitämään yhdenmukaisia tiedostoviittauksia erilaisissa ympäristöissä, joissa tietovarastoa voidaan käyttää, koska se ei perustu absoluuttisiin polkuihin, jotka voivat vaihdella järjestelmien välillä.
    • Siemens PLC -projekti: Siemens PLC -projektien hallinnassa tuemme sekä pakattua .zap-tiedostoa että pakkaamatonta kansiorakennetta, joka sisältää .ap-tiedostoja. Näin voit työskennellä näiden muotojen kanssa:
      • Pakattu tiedosto: Jos projektisi on pakatussa muodossa, voit käyttää .zap-tiedostoa suoraan. Tämä on hyödyllistä projektien helppoon siirtämiseen yhtenä pakettina. Käytä esimerkiksi tiedostopolkua:
        • ./Projects/PLC1/MySiemensPLCProject.zap17
        • ./MySiemensPLCProject.zap19
      • Pakkaamaton kansio: Vaihtoehtoisesti voit työskennellä pakkaamattoman kansion kanssa, joka sisältää .ap-tiedostot. Tämä ratkaisu helpottaa pääsyä yksittäisiin projektin osiin, mikä voi olla hyödyllistä kehityksen tai virheenkorjauksen aikana. Käytä seuraavaa polkua projektiisi pääsemiseksi:
        • ./Projects/PLC1/MySiemensPLCProject/MySiemensPLCProject.ap17
        • ./MySiemensPLCProject/MySiemensPLCProject.ap19
    • Rockwell PLC -projekti: Rockwell PLC -projekteissa prosessi on yksinkertaisempi. Nämä projektit sisältyvät yhteen .ACD-tiedostoon, mikä yksinkertaistaa projektin hallintaa ja jakamista. Noudata näitä vaiheita päästäksesi Rockwell PLC -projektiisi:
      • ACD-tiedosto: .ACD-tiedosto sisältää kaikki tarvittavat projektitiedot. Osoita vain tiedostoon:
        • ./Projects/PLC1/MyRockwellPLCProject.ACD
        • ./MyRockwellPLCProject.ACD

Esimerkki config.sda.json-tiedostosta​

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

Onnistuneen määrityksen jälkeen tietovarastosi on liitetty SEW-projektiin, mikä helpottaa yhteistyötä ja projektinhallintaa. Tästä eteenpäin jokainen uusi GitHub-tietovarastoosi lähetetty commit luo vastaavan projektiversion SEW-projektiisi.