GitHub (Strings)

Obsah je strojově přeložen z angličtiny s použitím Phrase Language AI.

Tip

Informace o integraci GitHub v Phrase TMS naleznete v GitHub (TMS).

Phrase Strings se integruje s repozitáři GitHub za účelem synchronizace lokalizačních souborů mezi Phrase a GitHubem.

Ve výchozím nastavení jsou repozitáře propojeny pomocí aplikace GitHub OAuth. Podporovány jsou také osobní přístupové tokeny, které jsou určeny především pro instance s vlastním hostováním nebo pro prostředí, kde instalace aplikace OAuth není možná.

Předpoklady

Konfigurační soubor .phrase.yml configuration musí být přítomen v kořenovém adresáři větve, která má být monitorována. Soubor definuje, které soubory chcete importovat (pull) nebo exportovat (push) z úložiště.
Úložiště vyžaduje přístup pro čtení i zápis.
Nesprávně definované konfigurační soubory mohou způsobit chyby. Ujistěte se, že soubor obsahuje alespoň jeden cíl pro push a pull, správné formáty souborů a správné nastavení parametru update_translations.
Aplikace GitHub OAuth:
- Aplikace GitHub OAuth musí být nainstalována v organizaci nebo účtu GitHub, kterému repozitář patří.
- Repozitář musí být zahrnut v instalaci aplikace OAuth.
- V cílové organizaci nebo účtu jsou vyžadována oprávnění k instalaci nebo autorizaci aplikací GitHub.
- Podporuje propojení účtu Strings s více organizacemi GitHub. V konfiguraci integrace vyberte, která organizace GitHub se má synchronizovat. Počet organizací, které lze propojit, není nijak pevně omezen.
Přístupový token GitHub:
- Klasické tokeny
  
  Vyžaduje rozsah repo (public_repo při synchronizaci s veřejným repozitářem)
- Tokeny s jemným nastavením oprávnění
  
  Vyžaduje následující oprávnění:
  - Obsah: Pro čtení a zápis
  - Žádosti o stažení: Pro čtení a zápis
- Ujistěte se, že nastavení úložiště nevyžaduje podepsané revize.
Pokud je v GitHubu povoleno SSO, musí být povoleno i pro přístupový token.
Větev phrase_translations nelze ochránit.

Poznámka

Z důvodu kontinuálního vylepšování nemusí uživatelské rozhraní vypadat stejně jako na videu.

Připojit úložiště

Jakmile je konfigurační soubor na svém místě, postupujte podle těchto kroků pro připojení úložiště:

V hlavní navigaci klikněte na Automatizace, poté na Synchronizace úložišť.

Případně na stránce Integrace přejděte dolů na Synchronizace úložišť a klikněte na Konfigurovat.

Otevře se stránka Synchronizace úložišť. Seznam Synchronizace úložišť zobrazuje pouze projekty, ke kterým má prohlížející uživatel přístup.
Klikněte na Přidat synchronizaci/GitHub.

Otevře se okno nastavení GitHub sync.
Vyberte projekt z rozevíracího seznamu.
Vyberte metodu ověření:
- Github App (doporučeno)
  
  Pokud aplikace GitHub ještě není nainstalována, klikněte na Ověřit. Ověření se provádí jednou a lze jej znovu použít pro synchronizaci více úložišť.
  
  Pokud je aplikace GitHub již nainstalována, klikněte na Spravovat instalaci pro dokončení instalace aplikace pro cílovou organizaci nebo účet. Přístup k úložišti se spravuje na úrovni organizace nebo účtu a není vázán na jednotlivého uživatele GitHubu.
- Osobní přístupový token
  
  Poskytněte osobní přístupový token k úložišti s rozsahem API.
  
  Při použití osobního přístupového tokenu závisí přístup k úložišti na uživateli GitHubu, který token vytvořil.
- Samostatně hostovaná relace
  
  Poskytněte koncový bod API vlastního hostitele GitHubu a osobní přístupový token k úložišti s rozsahem API.
Pokud cílové úložiště vyžaduje ověřené (podepsané) commity, měla by se použít metoda ověřování pomocí aplikace GitHub. Commity odeslané pomocí osobního přístupového tokenu nejsou podepsány, takže synchronizace selže s následující chybou: „Repozitář vyžaduje ověřené (podepsané) commity.“
Pokud je aplikace GitHub použita, vyberte z rozevíracího seznamu Propojená organizace GitHub. Seznam repozitářů se načte na základě tohoto výběru.
Vyberte z rozevíracího seznamu GitHub repozitář.
Vyberte z rozevíracího seznamu větev repozitáře, ze které chcete provádět import (push) a do které export (pull). Obvykle se jedná o hlavní větev (master branch).
Volitelně zadejte název větve pro pull request. Pokud pole ponecháte prázdné, vytvoří se větev s výchozí hodnotou phrase-translations.
Volitelně zadejte vlastní Commit title pro pull request, maximálně 72 znaků.

Pokud pole ponecháte prázdné, zachová se výchozí zpráva Updated translations from Phrase. Jakmile je nastaven, vlastní název nahradí výchozí zprávu commitu a název pull requestu při každém exportování.
Klikněte na Validate Configuration a ověřte, že nastavení autentizace a konfigurační soubor jsou správné.
Volitelně můžete vybrat možnost Import behavior pro určení, kdy se nové nebo aktualizované soubory automaticky importují do projektu.
Klikněte na Uložit.

Projekt je nyní připojen k vybranému GitHub repozitáři a přidán do seznamu.
(Nepovinné) Klikněte na ikonu tužky pro přejmenování integrace.

Aplikace GitHub od Phrase v současnosti nepodporuje seznam povolených IP adres. Pokud má organizace GitHub povolen seznam povolených IP adres se zapnutým nastavením „Enable IP allow list configuration for installed GitHub Apps“, GitHub zablokuje aplikaci Phrase GitHub, což vede k prázdnému rozbalovacímu seznamu repozitářů a selhání exportů. Jako řešení přidejte odchozí IP adresy Phrase do seznamu povolených adres organizace. Aktuální seznam adres, které je třeba povolit, naleznete v článku Phrase Servers IP Addresses.

Import souborů

Zajistěte, aby byly příkazy push správně nakonfigurovány v souboru .phrase.yml configuration. Možnosti push jsou stejné jako pro API koncový bod uploads.

Chcete-li importovat soubory:

Na stránce Repo Syncs vyberte projekt a klikněte na Import .

Jazykové soubory (definované jako položky push jako zdroje v konfiguračním souboru) jsou importovány do projektu.

Musí být přítomna výchozí lokalizace.

Poznámka

V případě problémů při importu použijte klienta CLI pro místní otestování konfiguračního souboru .phrase.yml a zkontrolujte případné chybové zprávy.

V případě potřeby kontaktujte technickou podporu Phrase a k žádosti o podporu přiložte konfigurační soubor .phrase.yml.

Exportovat soubory

Zajistěte, aby byly příkazy pull správně nakonfigurovány v souboru .phrase.yml configuration. Možnosti pull (např. parametr include_empty_translations) jsou stejné jako pro API koncový bod locales download.

Chcete-li exportovat soubory:

Na stránce Repo Syncs vyberte projekt a klikněte na Export .

Zobrazí se okno Export.
Do pole PR branch zadejte cílovou větev.

Nejnovější soubory v úložišti budou exportovány jako nový požadavek na stažení (pull request) do požadované větve.
Jakmile jsou soubory exportovány, lze požadavek na stažení v úložišti sloučit nebo zavřít a větev lze odstranit.

Poznámka

V případě problémů při exportu použijte klienta CLI k místnímu otestování konfiguračního souboru .phrase.yml a zkontrolujte případné chybové zprávy.

V případě potřeby kontaktujte technickou podporu Phrase a k žádosti o podporu přiložte konfigurační soubor .phrase.yml.

Historie

Synchronizace úložišť uchovává historii posledních importů a exportů pro každý projekt Phrase Strings.

Chcete-li zobrazit historii:

Na stránce Repo Syncs vyberte projekt a klikněte na Historie .

Zobrazí se historie importu a exportu pro daný projekt. Záznamy exportu v historii obsahují odkaz na odpovídající žádost o sloučení.