Integrazione con GitHub

Collega spazi direttamente con i repository GitHub per essere sempre aggiornato sul lavoro correlato.

I proprietari dello spazio di lavoro e gli amministratori possono collegare gli Spazi ai loro repository, permettendo ai membri di aggiungere il loro lavoro su Github alle attività.

Le attività negli spazi con un repository collegato possono essere associate a commit, rami e richieste di unione.

Cosa ti serve

  • L'integrazione GitHub è disponibile su ogni piano ClickUp.
  • Solo gli amministratori del repository possono aggiungere repository GitHub a ClickUp. Una volta aggiunti, gli amministratori dello spazio di lavoro possono aggiungere quei repository agli spazi di ClickUp!
  • Solo i proprietari e gli amministratori dello spazio di lavoro possono aggiornare le configurazioni dello spazio di lavoro nella Central de Aplicativos .
  • Solo i proprietari dello spazio di lavoro e gli amministratori possono aggiungere e collegare repository agli spazi.
  • Solo i proprietari e gli amministratori dello spazio di lavoro possono creare connessioni dello spazio di lavoro. È consentita la connessione a più spazi di lavoro.
  • I membri e gli altri possono creare connessioni personali.
  • Ospiti e membri con accesso limitato non possono utilizzare l'integrazione con GitHub.

Tipi di connessione

Le funzionalità/funzione disponibili dipendono dal tipo di connessione utilizzata.

I comandi ClickUp sono disponibili solo per Connessioni Personali. I dati non sono collegati alle Connessioni dell'area di lavoro. Quando un utente ha una connessione personale abilitata ed esegue un comando GitHub, vedrà un elenco di opzioni, come gli elenchi dei repository, che è autorizzato a visualizzare in GitHub.

Tipi di connessione Descrizione Funzionalità Comandi
Connessione personale Collega il tuo account GitHub al tuo account utente ClickUp per ogni area di lavoro che hai creato o a cui ti sei unito. I dati nel tuo account GitHub non saranno disponibili a nessun altro tramite ClickUp.

Ricerca Personale Connessa:

Cerca record pubblici e privati dal tuo account GitHub connesso. Nessun altro può cercare i documenti delle tue connessioni personali.

Anteprime dei link GitHub

Le anteprime dei collegamenti ti permettono di vedere visualizzazioni live e sincronizzate dei link direttamente in ClickUp.

Pannello delle app nella vista Attività:

Visualizza i link di GitHub da un luogo centrale nella vista Attività.

Apri GitHub: apri GitHub in una nuova scheda.

 

Crea nuovo problema GitHub: Crea un nuovo problema su GitHub da ClickUp.

 

Crea nuovo Gist su GitHub: apre una scheda alla pagina di creazione del Gist.

 

Crea un nuovo ramo GitHub: Crea un nuovo ramo GitHub da ClickUp.

 

Crea una nuova richiesta pull su GitHub: Il modo più veloce per creare una richiesta pull su GitHub.

Connessioni all'area di lavoro

Il titolare dell'area di lavoro o gli amministratori possono abilitare GitHub come connessione all'area di lavoro.

Utilizza questa connessione per dare a tutti l'accesso alla ricerca connessa.

Ricerca connessa nell'area di lavoro

La Ricerca Connessa dell'area di lavoro permette a tutti i membri dell'area di lavoro di cercare sia record pubblici che privati dall'account connesso.

 

Esempio pratico

Il team di ingegneria della tua app mobile e il team di sviluppo del sito web lavorano in repository e Spazi separati, all'interno della stessa organizzazione GitHub e dello stesso Spazio di lavoro ClickUp.

Per iniziare con l'integrazione:

  1. Il proprietario dello spazio di lavoro o l'amministratore crea una connessione GitHub nello spazio di lavoro.
  2. Il gestore dell'app mobile collega il repository app-mobile di GitHub allo spazio di sviluppo dell'app mobile.
  3. Il gestore del sito web collega il repository GitHub del sito web allo spazio marketing sito web.
  4. Le attività negli spazi sviluppo app mobile e sito web di marketing ora mostrano l'icona di GitHub, permettendo a entrambi i team di collegare le loro attività con commit, rami e richieste pull di GitHub.

Configura l'integrazione

Ci sono quattro passaggi per configurare l'integrazione con GitHub in ClickUp:

  1. Collega GitHub.
  2. Collega i repository GitHub al tuo area di lavoro.

    I repository sono necessari affinché ClickUp possa collegare automaticamente le richieste di pull alle rispettive attività di ClickUp.

  3. Collega i repository GitHub agli spazi di ClickUp.
  4. Opzionalmente, puoi impostare un formato personalizzato per il nome del branch.

Passo 1: Connetti GitHub

Scopri come collegare l'integrazione di GitHub.

Passaggio 2: Collega i repository GitHub al tuo area di lavoro

Solo il titolare della connessione può aggiungere repository. 

Collegare un repo non concede agli utenti di ClickUp l'accesso al codice sorgente del tuo repo.

Per aggiungere un repository a un'area di lavoro:

  1. Nel Centro App, cerca e seleziona GitHub.
  2. Clicca su Impostazioni dello Spazio di lavoro.
  3. Accanto a Collega repository a ClickUp, clicca su Aggiungi repository.
  4. Seleziona tutti i repository che vuoi aggiungere.

Se non visualizzi i repository corretti, assicurati di aver effettuato l'accesso con l'account giusto. Un titolare dell'area di lavoro o un amministratore deve selezionare ogni repository da connettere. I repository collegati possono essere visualizzati nell'App Center.

Passaggio 3: Collega i repository GitHub agli spazi ClickUp

Dopo aver aggiunto i repository al tuo area di lavoro, un amministratore può aggiungere ciascun repository a uno o più spazi. Ogni spazio di ClickUp può avere più repository aggiunti.

Puoi aggiungere o rimuovere repository dagli spazi in qualsiasi momento.

Per collegare un repository a uno spazio:

  1. Apri GitHub nel Centro di Applicazioni.
  2. Clicca su Impostazioni dello Spazio di lavoro.
  3. Clicca sul nome del repository che vuoi collegare.
  4. Clicca su + Aggiungi spazio.
  5. Ripeti per gli altri spazi che desideri collegare.

Passo 4: Imposta il formato del nome del tuo branch

Se la tua organizzazione utilizza un formato specifico per i nomi dei rami, puoi impostarlo dalla pagina di GitHub nel App Center. Quando le persone creano rami dalle attività di ClickUp, verrà utilizzato questo formato.

Il formato predefinito è: :taskId:_:taskName:_:username:

Per esempio: CU-ae27de_Auto-generated-naming_John-smith

Le opzioni disponibili sono mostrate nella tabella seguente:

Valore Descrizione
:username: Il nome utente del conto ClickUp che ha creato il ramo. Gli spazi sono sostituiti da un trattino.
:taskId: L'ID della tarefa ClickUp dove il branch è creato. Include il prefisso richiesto.
:nomeDellaTarefa: Il nome della task dove viene creato il branch. Gli spazi sono sostituiti da un trattino.

Per impostare il formato del nome predefinito da GitHub nel Centro App:

  1. Clicca su Impostazioni dello Spazio di lavoro.
  2. Sotto Nome del ramo auto-generato, inserisci il formato del nome del ramo che preferisci.
  3. Fai clic su Salva.

Screenshot di qualcuno che crea un nome di ramo generato automaticamente.

Cerca file su GitHub usando la Ricerca collegata

Utilizza la Ricerca connessa dell'area di lavoro per consentire a tutti i membri dell'area di lavoro di cercare qualsiasi file pubblico dai repository che aggiungi.

Collega le attività da GitHub

ClickUp associa automaticamente le nuove attività di GitHub alle tasse se includi un valido ID della tarefa ClickUp in qualsiasi parte del titolo della richiesta di pull, della descrizione della richiesta di pull, del nome del branch o del messaggio di commit.

Quando un ID di tarefa ClickUp è incluso in una richiesta di pull, verrà pubblicato un commento con un link alla tarefa ClickUp nella richiesta di pull. Un link non verrà visualizzato quando si incolla manualmente una richiesta di pull in una task ClickUp.

Il commento sarà pubblicato utilizzando l'account GitHub della persona che ha configurato il repo e il mapping dello spazio.

L'ID della tarefa deve essere formattato utilizzando una di queste opzioni:

#{task_id}

CU-{task_id}

{custom_task_id}

#{custom_task_id}

Ad esempio:

#1abc2de

CU-1abc2de

It seems like there might have been a misunderstanding or an error in your request. You've provided "eng-123" which doesn't appear to be a valid input or a request for translation. Could you please provide more details or clarify your request so I can assist you effectively?

#eng-123

Collega tarefa da ClickUp

Puoi anche collegare manualmente le attività di ClickUp con commit, branch e pull request di GitHub direttamente dall'attività di ClickUp. Assicurati che la task sia situata in uno Spazio che è collegato a un repository.

Per collegare una task:

  1. Apri un'attività e clicca sull'icona di GitHub.

    A destra, vedrai suggeriti nomi di branch e messaggi di commit che puoi copiare nella tua area di trasferimento. Puoi anche copiare l'ID della task da qui.

  2. Nell'angolo in basso a destra, clicca su Aggiungi link GitHub.
    Screenshot della finestra modale per aggiungere un collegamento GitHub.
  3. Incolla un link.
  4. Nell'angolo in basso a destra, clicca su Aggiungi.

Attività dell'attività di ClickUp

Il feed delle attività delle attività a volte comprime elementi di attività simili per garantire che tu veda i dettagli più importanti.

Puoi intraprendere le seguenti azioni per localizzare l'attività su GitHub:

  • Clicca su Altri aggiornamenti per mostrare le attività che sono state nascoste.
  • Quando un ramo viene unito, i commit vengono visualizzati come un unico elemento di attività nel feed di attività dell'attività.
    • Clicca sul link per visualizzare tutti i commit e aprire una finestra modale.
    • Clicca su un commit singolo per aprirlo su GitHub.
  • Filtra le azioni in base agli elementi di Git.
     

Screenshot di qualcuno che filtra l'attività di un'attività per elementi Git.

Attività mancante 

Se non riesci a localizzare certe attività, assicurati di fare riferimento correttamente all'ID attività ClickUp per collegare l'attività in GitHub. Puoi utilizzare una di queste tre opzioni per fare riferimento alle tue attività ClickUp nei commit, nei nomi dei rami e nelle richieste di unione:

#{task_id}

CU-{task_id}

{custom_task_id}

Ad esempio:

#1abc2de

CU-1abc2de

prefisso-1

Puoi collegare manualmente le attività di ClickUp con i commit, i rami e le richieste pull di GitHub dall'attività di ClickUp.

Anteprime dei link GitHub

Quando incolli un link di GitHub in un'attività di ClickUp, Chat, o Documento, vedrai l'opzione per incollarlo come anteprima, menzione o URL.

Screenshot di qualcuno che incolla un link in un commento dell'attività.png

Crea problemi, branch e richieste di pull su GitHub da ClickUp

Puoi anche creare nuovi problemi, rami e richieste di unione direttamente dalle attività. Assicurati che l'attività sia situata in uno spazio collegato a un repository.

Per creare un problema, un ramo o una richiesta pull:

  1. Apri un'attività e clicca sull'icona di GitHub.
    A destra, vedrai i nomi dei rami suggeriti e i messaggi di commit che potrai copiare negli appunti. Puoi anche copiare l'ID dell'attività da qui.
  2. Nell'angolo in basso a destra, clicca su Aggiungi link GitHub.
  3. Scegli una delle seguenti opzioni:
    • Nuovo problema su GitHub
    • Nuovo ramo GitHub
    • Nuova richiesta di pull su GitHub
  4. Denomina il problema, il branch o la richiesta di pull.
  5. Seleziona un repository e compila le informazioni. Aggiungi un branch sorgente e un branch destinatario se applicabile.
    Screenshot di una persona che crea un nuovo problema GitHub.
  6. Fai clic su Crea.

Pannello GitHub nella vista Attività

Dopo aver incollato il tuo primo link di GitHub nella descrizione dell'attività o in un commento, vedrai comparire una nuova icona GitHub nella barra laterale destra della tua  vista Attività. Puoi cliccare su questa icona in qualsiasi momento per visualizzare tutti i link di GitHub inseriti nell'attività.

Screenshot della scheda GitHub in un'attività dopo che qualcuno ha aggiunto un branch e un problema da ClickUp.

L'attività della task su GitHub utilizza il nome utente di ClickUp della persona, o il loro nome utente GitHub se non possiedono un account ClickUp.

Aggiorna gli stati delle attività da GitHub

Puoi aggiornare lo status di una tarefa ClickUp quando colleghi un commit, fai un push di un commit o crei una richiesta di pull. ClickUp rileva automaticamente le nuove attività su GitHub e le associa alle tasse se includi un ID della tarefa valido in qualsiasi parte del titolo della richiesta di pull, della descrizione della richiesta di pull, del nome del branch o del messaggio di commit.

L'ID della tarefa deve essere formattato utilizzando una di queste opzioni:

#{task_id}[status]

CU-{task_id}[status]

{custom_task_id}[stato]

#{custom_task_id}[status]

Per aggiornare lo status di una attività:

  1. Aggiungi l'ID della tarefa ClickUp in qualsiasi parte del messaggio di commit o della richiesta di pull.
  2. Includi lo stato aggiornato dell'attività tra parentesi quadre.

Ad esempio: #ud5b[pronto]

Tutti i formati elencati nella sezione Collega compiti da GitHub di questo articolo possono essere utilizzati. Per garantire una corretta formattazione, non aggiungere uno spazio tra l'ID attività e le informazioni sullo stato.

Puoi anche aggiornare gli stati delle attività utilizzando le Automazioni di GitHub!

Gestisci problemi, rami, richieste pull e commit di GitHub da ClickUp

Dopo aver collegato problemi, branch, richieste di pull o commit, questi verranno visualizzati sul lato destro della tua tarefa quando clicchi sull'icona GitHub. Utilizza il menu puntini di sospensione ... per copiare il link o eliminare l'elemento.

Se ti sei unito all'area di lavoro come ospite, non potrai utilizzare l'integrazione con GitHub. Contatta il titolare dell'area di lavoro o l'amministratore per richiedere un aggiornamento a membro dell'area di lavoro.

Una volta collegato un elemento di GitHub, le seguenti informazioni verranno visualizzate nella tua attività ClickUp:

Informazioni sul problema

Dopo che un problema è collegato, puoi vedere i seguenti dettagli:

  • La persona che ha aperto il problema, conosciuta come autore
  • Qualsiasi revisore assegnato
  • Link creato
  • Repository
  • Lo stato del problema.
  • URL

Informazioni sul ramo

Dopo che un branch è collegato, puoi vedere i seguenti dettagli:

  • La persona che ha creato il branch, conosciuta come autore
  • Creatore di link
  • Repository
  • URL

Informazioni sulla richiesta pull

Dopo che una richiesta di pull è stata collegata, puoi vedere i seguenti dettagli:

  • La persona che ha aperto la richiesta di pull, nota come autore
  • Qualsiasi revisore assegnato
  • Assegnatari
  • Modifiche alla linea
  • Link creato
  • Repository
  • Ramo di origine
  • Ramo di destinazione
  • Lo stato della richiesta pull
  • URL

Informazioni sul commit

Dopo che un commit è collegato, puoi vedere i seguenti dettagli:

  • La persona che ha creato il commit, conosciuta come l'autore
  • File modificati
  • Modifiche alla linea
  • Link creato
  • Repository
  • URL

Aggiungi il tuo account GitHub a ClickUp

I membri dello spazio di lavoro possono collegare i loro account GitHub al loro account ClickUp in anticipo o quando creano un branch o una richiesta di pull.

Per aggiungere il tuo account GitHub dalla Central di Applicazioni:

  1. Cerca e seleziona GitHub.
  2. Clicca sulla scheda Personale.
  3. Accanto a Crea una connessione personale, clicca su Connetti.
  4. Accedi a GitHub e autorizza ClickUp.

Visualizza le richieste di pull in vista Elenco o Tabella

Aggiungi la colonna Richieste pull a qualsiasi vista Elenco o Tabella per visualizzare rapidamente le tue richieste pull di GitHub.

Problemi di connessione

A volte, l'account GitHub sbagliato è collegato o c'è un problema con la connessione. In questo scenario, puoi provare a disconnettere e ricollegare i tuoi repository o l'intero account.

Queste azioni non influenzano la capacità di nessuno di accedere ai repository utilizzando il proprio account GitHub tramite GitHub.

Per disconnettere un repository:

  1. Dal App Center, seleziona GitHub.
  2. Nell'angolo in alto a destra, clicca su Impostazioni dell'area di lavoro.
  3. In Repository, clicca sul menu puntini di sospensione ... alla destra del repository.
  4. Clicca su Elimina da ClickUp.

La sezione sottostante include istruzioni per disconnettere l'intero account.

Disconnetti l'integrazione con GitHub

Se non hai più bisogno di accedere ai file di GitHub in ClickUp, puoi scollegare l'integrazione dall'App Center:

  1. Cerca e seleziona GitHub.
  2. Seleziona la scheda Area di lavoro.

    Solo i titolari e gli amministratori possono disconnettere le connessioni dell'area di lavoro.

  3. Accanto a Connesso, clicca sul menu puntini ....
  4. Seleziona Disconnetti.
  5. Per confermare, fai clic su Disconnetti.

Ambiti OAuth

Di seguito è riportata una tabella di tutti gli ambiti OAuth per l'integrazione con GitHub, così puoi prendere decisioni informate su sicurezza e conformità prima di attivarla nel tuo area di lavoro.

Ambito Descrizione
read:user Identifica l'utente e il profilo di base
repo Permette l'indicizzazione dei contenuti del repository, svelare i link e eseguire comandi del repository
admin:repo_hook Consente di creare e gestire webhook per le funzionalità di sincronizzazione
Progetto Quando abilitato, consente l'accesso ai dati di progetti e bacheche.
read:org Quando abilitato, consente l'accesso ai dati di progetti e bacheche.