Passa al contenuto principale

Integrazione GitHub

Panoramica dell'integrazione GitHub​

SDA attualmente supporta l'integrazione con GitHub, consentendo di collegare il proprio account e i propri repository GitHub direttamente alla piattaforma. Attraverso questa connessione, GitHub può funzionare come repository locale con controllo di versione che rimane sincronizzato con il repository SDA. Gli amministratori possono configurare l'autenticazione, selezionare i repository e gestire le impostazioni di sincronizzazione, permettendo ai team di mantenere i consueti flussi di lavoro GitHub beneficiando al contempo delle funzionalità di gestione centralizzata dei progetti e di automazione di SDA.

Caratteristiche principali dell'integrazione​

L'integrazione di GitHub con SDA offre diversi vantaggi:

  • Flusso di lavoro semplificato: integra in modo trasparente il robusto controllo di versione di GitHub con le funzionalità di versionamento dei progetti PLC e di gestione PLC di SDA, migliorando la collaborazione del team.
  • Gestione centralizzata: combina i repository di codice e la gestione dei progetti PLC in un'unica piattaforma per semplificare l'amministrazione e il controllo degli accessi.
  • Automazione e distribuzione: utilizza le pipeline di SDA per le funzionalità di distribuzione automatizzata, semplificando i rilasci dei progetti direttamente dai repository GitHub.
  • Collaborazione in tempo reale: aggiornamenti e modifiche vengono sincronizzati istantaneamente, garantendo che tutti i membri del team lavorino con la versione più recente del progetto.

Integrando GitHub con SDA, il tuo team può aumentare la produttività e l'efficienza dei progetti.

Come collegare SDA a GitHub​

Configurare GitHub per l'integrazione con SDA​

  1. Accedi a GitHub: assicurati di avere a disposizione le tue credenziali GitHub.
  2. Genera un Personal Access Token: per fornire l'accesso a SDA, vai su Developer settings, scegli Personal access tokens e crea un nuovo Fine-grained token. Imposta i permessi su Contents e Metadata per i repository che desideri condividere.
  3. Copia il token: conserva il token in modo sicuro, poiché verrà utilizzato durante il processo di autenticazione in SDA.

Seguendo questi passaggi preparatori, il tuo account GitHub sarà pronto per l'integrazione con SDA, consentendoti di beneficiare di una collaborazione e di una gestione dei progetti migliorate.

Collegare GitHub al tuo account SDA​

Per collegare la tua piattaforma SDA a GitHub, segui questi passaggi:

  1. Accedi alle impostazioni: vai alla piattaforma SDA e apri la sezione "General Settings".
  2. Crea una nuova integrazione: vai alla sezione Integrations e aggiungi una nuova integrazione facendo clic su Add Integration.
  3. Autentica l'account GitHub: nella finestra Add Integration, inserisci il nome dell'integrazione e incolla il tuo access token GitHub.

Configurare i webhook per gli aggiornamenti automatici​

Per abilitare gli aggiornamenti automatici e garantire che SDA venga informato tempestivamente delle modifiche, è necessario configurare correttamente i webhook nei tuoi repository GitHub. Ecco come procedere:

  1. Accedi alle impostazioni del repository:

    • Inizia navigando verso il tuo repository GitHub.
    • Fai clic sulla scheda "Settings", che si trova solitamente all'estrema destra della barra di navigazione del repository.

  2. Individua la sezione Webhooks:

    • Una volta nelle impostazioni, scorri verso il basso o cerca l'opzione "Webhooks" nel menu a sinistra.
    • Fai clic su "Webhooks" per gestire e aggiungere nuovi hook.

  3. Crea un nuovo webhook:

    • Premi il pulsante "Add webhook" per avviare la configurazione di un nuovo webhook.
    • Ti verrà richiesto di inserire un Payload URL, ovvero l'endpoint a cui desideri inviare richieste HTTP POST quando si verificano determinati eventi. Puoi copiare questo valore dall'integrazione appena creata.

  4. Configura il payload del webhook:

    • In "Content type", scegli application/json per assicurarti di ricevere i dati in un formato strutturato.
    • Imposta la chiave segreta per proteggere il tuo webhook da accessi non autorizzati. Puoi copiare questo valore dalla tua integrazione SDA.

  5. Seleziona gli eventi:

    • Scegli l'opzione "Just push events".

  6. Completa la configurazione:

    • Verifica nuovamente le configurazioni.
    • Fai clic su "Add webhook" per completare e attivare il webhook.

Una volta configurato, il tuo webhook invierà gli aggiornamenti a SDA.

Collegare un repository a un progetto SDA​

Per collegare un repository a un progetto SDA, segui questi passaggi:

  1. Accedi alla sezione del progetto: apri il tuo progetto SDA.

  2. Accedi al menu di modifica del progetto: seleziona i tre puntini nell'angolo in alto a destra della pagina del progetto.

  3. Collega il repository:

    • Seleziona "Link to Repository".
    • Scegli dall'elenco un repository da collegare.

  4. Conferma: verifica che la configurazione funzioni. Se l'operazione è riuscita, vedrai un'icona GitHub nell'intestazione dei dettagli del progetto.

Preparare il repository per l'integrazione con SDA​

Ora che il tuo repository è configurato e connesso, prepara il suo contenuto affinché SDA possa comprendere come gestirlo.

Struttura delle cartelle del repository GitHub​

Il processo di integrazione SDA richiede che ogni repository contenga un singolo progetto PLC. Sebbene la struttura delle cartelle possa essere personalizzata dall'utente, la cartella radice deve contenere un file config.sda.json. Questo file specifica il vendor e la versione dell'IDE del progetto PLC.

Schema del file di configurazione

  • schema_version: indica la versione dello schema del file di configurazione. Il valore predefinito è 1.0.0, che supporta miglioramenti futuri e mantiene la compatibilità con le versioni precedenti.
  • vendor: specifica il vendor del progetto PLC. I valori accettati sono:
    • siemens
    • rockwell
  • ide_version: specifica la versione del progetto PLC. Segue il formato {major}.{minor}.{patch}. Ad esempio, Siemens TIA V17 corrisponde a 17.0.0 e Rockwell V37 è rappresentato come 37.0.0.
  • project_path: questo campo specifica il percorso corretto del progetto PLC all'interno del repository. Utilizza un formato di percorso relativo che parte dalla cartella radice del repository. Ciò significa che, quando imposti project_path, non devi includere la directory radice stessa nel percorso. Fornisci invece i segmenti di percorso che portano alla cartella specifica del progetto PLC. Ad esempio, se il tuo progetto PLC si trova in una cartella denominata Projects che risiede direttamente nella directory radice e, all'interno di Projects, esiste una cartella PLC1 in cui sono conservati i file di progetto desiderati, il tuo project_path sarà ./Projects/PLC1/MySiemensPLCProject.zap17. Questa configurazione aiuta a mantenere riferimenti ai file coerenti nei diversi ambienti in cui il repository può essere utilizzato, poiché non si basa su percorsi assoluti che possono variare da un sistema all'altro.
    • Progetto Siemens Automation: per la gestione dei progetti Siemens automation, offriamo supporto sia per il file compresso .zap sia per la struttura di cartelle non compressa che include i file .ap. Ecco come lavorare con questi formati:
      • File compresso: se il tuo progetto è in formato compresso, puoi utilizzare direttamente il file .zap. Questo è utile per trasferire facilmente i progetti come pacchetto unico. Ad esempio, utilizza il percorso file:
        • ./Projects/PLC1/MySiemensPLCProject.zap17
        • ./MySiemensPLCProject.zap19
      • Cartella non compressa: in alternativa, puoi lavorare con una cartella non compressa che contiene i file .ap. Questa configurazione consente un accesso più semplice ai singoli componenti del progetto, il che può essere vantaggioso durante lo sviluppo o il debug. Utilizza il seguente percorso per accedere al tuo progetto:
        • ./Projects/PLC1/MySiemensPLCProject/MySiemensPLCProject.ap17
        • ./MySiemensPLCProject/MySiemensPLCProject.ap19
    • Progetto Rockwell Automation: per i progetti Rockwell automation, il processo è semplificato. Questi progetti sono racchiusi in un unico file .ACD, semplificando la gestione e la condivisione del progetto. Segui questi passaggi per accedere al tuo progetto PLC Rockwell:
      • File ACD: il file .ACD comprende tutti i dati di progetto necessari. È sufficiente indicare il file:
        • ./Projects/PLC1/MyRockwellPLCProject.ACD
        • ./MyRockwellPLCProject.ACD

Esempio di file config.sda.json​

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

Al completamento dell'operazione, il tuo repository sarà collegato al progetto SDA, facilitando la collaborazione e la gestione del progetto. Da questo momento, ogni nuovo commit inviato al tuo repository GitHub creerà una versione di progetto corrispondente nel tuo progetto SDA.