Consiglio
Per informazioni sull'integrazione di GitHub in Phrase TMS, fare riferimento a GitHub (TMS).
Phrase Strings si integra con gli archivi GitHub per sincronizzare i file di localizzazione tra Phrase e GitHub.
Per impostazione predefinita, gli archivi vengono connessi utilizzando una GitHub OAuth App. Sono supportati anche i token di accedere personali, destinati principalmente a istanze self-hosted o ambienti in cui l'installazione di un'OAuth App non è possibile.
Prerequisiti
-
Il file di configurazione
.phrase.ymldeve essere presente nella root del branch da monitorare. Il file definisce quali file importare (pull) o esportare (push) dall'archivio. -
Per l’archivio è necessaria l’autorizzazione alla lettura e alla scrittura.
-
I file di configurazione definiti in maniera errata potrebbero provocare degli errori. Assicurati che il file contenga almeno una destinazione push e una pull, formati di file corretti e l’impostazione corretta del parametro
update_translations. -
-
La GitHub OAuth App deve essere installata nell'organizzazione o nell'account GitHub che possiede l'archivio.
-
L'archivio deve essere incluso nell'installazione dell'OAuth App.
-
Sono necessarie le autorizzazioni per installare o autorizzare le GitHub App nell'organizzazione o nell'account di destinazione.
-
-
-
Token classici
Richiede l'ambito repo (
public_repose si esegue la sincronizzazione con un archivio pubblico) -
Token granulari
Richiede le seguenti autorizzazioni:
-
Contenuti: Lettura e scrittura
-
Pull request: Lettura e scrittura
-
-
Assicurati che le impostazioni dell’archivio non richiedano commit firmati.
-
-
Se SSO è abilitato in GitHub, deve essere abilitato anche per il token di accesso.
-
Il branch phrase_translations non può essere protetto.
Nota
A causa dei miglioramenti che vengono apportati regolarmente, l'interfaccia utente potrebbe apparire leggermente diversa da quella mostrata nel video.
Una volta inserito il file di configurazione, per connettere un archivio, seguire questi passaggi:
-
Dalla pagina , scorrere verso il basso fino a e fare clic su Configure.
Si apre la pagina .
-
Fare clic su Add Sync/GitHub.
Si apre la finestra delle impostazioni .
-
Selezionare un progetto dall'elenco a discesa.
-
Selezionare il metodo di autenticazione:
-
Se l'app GitHub non è ancora installata, fare clic su Authenticate. L'autenticazione viene eseguita una volta e può essere riutilizzata per più sincronizzazioni di archivi.
Se l'app GitHub è già installata, fare clic su Manage installation per completare l'installazione dell'app per l'organizzazione o l'account di destinazione. L'accesso all'archivio è gestito a livello di organizzazione o account e non è legato a un singolo utente GitHub.
-
Fornire un personale con un ambito API.
Quando si utilizza un token di accesso personale, l'accesso all'archivio dipende dall'utente GitHub che ha creato il token.
-
Fornire l' self-hosted di GitHub e un personale con un ambito API.
Se l'archivio di destinazione richiede commit verificati (firmati), è necessario utilizzare il metodo di autenticazione dell'app GitHub. I commit inviati utilizzando un token di accesso personale non sono firmati, pertanto la sincronizzazione non riesce con il seguente errore: \"L'archivio richiede commit verificati (firmati).\"
-
-
Selezionare un dall'elenco a discesa.
-
Selezionare un dall'elenco a discesa da cui importare (push) ed esportare (pull). Di solito si tratta del branch master.
-
Facoltativamente, fornire un nome di branch per la pull request. Se lasciato vuoto, verrà creato un branch con il valore predefinito .
-
Clicca Validate Configuration per assicurarti che le impostazioni di autenticazione e il file di configurazione siano corretti.
-
Facoltativamente, seleziona un'opzione di per determinare quando i file nuovi o aggiornati vengono importati automaticamente nel progetto.
-
Fai clic su Salva.
Il progetto è ora connesso all'archivio GitHub selezionato e aggiunto all'elenco.
-
(Facoltativo) Clicca l'pencil icon per rinominare l'integrazione.
Assicurati che i comandi di push siano configurati correttamente all'interno del file di impostazioni .phrase.yml. Le opzioni di push sono le stesse dell'endpoint uploads API.
Per importare i file:
-
Dalla pagina , seleziona un progetto e clicca importare
.
I file di lingua (definiti come voci di origine nel file di configurazione) vengono importati nel progetto.
Deve essere presente un impostazioni locali predefinito.
Nota
In caso di problemi durante l'importazione, usare il cliente CLI per testare localmente il file di configurazione
.phrase.ymle verificare la presenza di eventuali messaggi di errore.Se necessario, contatta il supporto tecnico Phrase e allega il file di configurazione
.phrase.ymlalla richiesta di supporto.
Assicurati che i comandi di pull siano configurati correttamente all'interno del file di impostazioni .phrase.yml. Le opzioni di pull (ad es. il parametro include_empty_translations) sono le stesse dell'endpoint download API.
Per esportare i file:
-
Dalla pagina , seleziona un progetto e clicca Esporta
.
Viene visualizzata la finestra .
-
Fornisci la destinazione branch nel campo .
I file più recenti nell'archivio verranno esportati come una nuova pull request verso la destinazione branch desiderata.
-
Una volta esportati i file, la pull request può essere unita o chiusa nell'archivio e il branch può essere eliminato.
Nota
In caso di problemi durante l'esportazione, usare il cliente CLI per testare il file di configurazione .phrase.yml localmente e controllare eventuali messaggi di errore.
Se necessario, contatta il supporto tecnico Phrase e allega il file di configurazione .phrase.yml alla richiesta di supporto.
Le sincronizzazioni dell'archivio mantengono una cronologia delle ultime importazioni ed esportazioni per ogni progetto Phrase Strings.
Per visualizzare la cronologia: