Jak mohu existující projekt migrovat na GitHub?

Dokončeno

Tady probereme důležité aspekty migrace projektu na GitHub ze starší verze systému správy verzí.

Proč migrovat na GitHub?

Existuje spousta literatury, která velebí přednosti GitHubu. Je nad rámec tohoto modulu, abyste vás přesvědčili, abyste se přesunuli. Můžeme ale rekapitulace některých klíčových výhod v kontextu témat, která je potřeba vzít v úvahu při plánování migrace.

Správa verzí

GitHub používá výhradně Git, pravděpodobně nejlepší systém správy verzí. Git je ale neuvěřitelně sofistikovaný a může prezentovat některé složité scénáře pro práci s kódem, se kterým váš tým nemusí být zkušený. Větve a žádosti o přijetí změn jsou pro vývojáře, kteří používají Git, zásadní součástí každodenního života, takže pochopení, kdy a jak je efektivně používat, je nezbytné k tomu, aby se na GitHubu úspěšně používaly. Je vhodné, aby se váš tým nejprve seznámil s tokem GitHubu, abyste se mohli dostat do běhu.

Uchování kódu v cloudu

Velké množství kódu projektu je stále uloženo ve starších systémech správy verzí za podnikovými bránami firewall. Když migrujete na GitHub, přesouváte kód na cloudovou platformu GitHubu, kde k němu členové týmu můžou snadno přistupovat odkudkoli. Tato migrace nabízí dobrou příležitost k revizi týmových zásad týkajících se toho, jaké druhy souborů a dat uchováváte ve správě verzí. Osvědčeným postupem je předpokládat, že dojde k ohrožení zabezpečení všeho, co potvrdíte do GitHubu. Nezapomeňte zahrnout citlivá data, jako jsou klíče rozhraní API, hesla nebo jiné soubory obsahující srovnatelné informace.

Poznámka:

GitHub nabízí veřejná i privátní úložiště, stejně jako odstupňované řízení přístupu k různým částem úložiště. To vám umožní řídit, komu budou vaše projekty viditelné a jaké akce může daný uživatel provádět.

Spolupráce

GitHub nabízí vynikající podporu pro týmovou spolupráci prostřednictvím funkcí, jako jsou problémy, žádosti o přijetí změn a revize kódu. Tok GitHubu se ale může lišit od postupů, na které je váš tým aktuálně zvyklý. Před dokončením migrace je vhodné zvážit, jestli se tým plánuje přizpůsobit GitHubu, zachovat si daný proces nebo se setkat někde uprostřed.

Pokud je projekt opensourcovým projektem, který umožňuje externím přispěvatelům, neexistuje lepší možnost než GitHub pro maximalizaci výhod.

Migrace na GitHub

Aspekty plánování

Nejdůležitějším aspektem před provedením migrace na GitHub je to, jestli potřebujete zachovat cokoli nad rámec aktuálního stavu vašeho zdroje. Pokud jste spokojení s zahájením nového projektu pouze s aktuálním zdrojem, jak je, je nejlepší s ním zacházet jako s novým projektem a nahrát zdroj do úložiště.

Pokud ale chcete zachovat historii správy verzí, musíte importovat pomocí nástroje GitHub Migrator. Další informace o podpoře importu pro různé platformy správy verzí najdete v tématu Import dat ze systémů správy verzí třetích stran.

Kromě dat Gitu můžete také chtít zachovat problémy, žádosti o přijetí změn nebo jiná data. Podpora těchto položek se liší podle platformy a je obecně dostupná z komunitních projektů. Tento modul nepokrývá migraci dat mimo Git.

Nakládání s binárními soubory aktuálně uloženými v projektu

Úložiště GitHubu by měla být omezena na soubory potřebné k vytváření projektů. Vyhněte se potvrzení velkých binárních souborů, jako jsou artefakty sestavení. Binární soubory, jako jsou tabulky a prezentace, se lépe sledují na portálech, které zajišťují jejich obsluhu a správu verzí. Pokud potřebujete verze velkých binárních souborů, zvažte použití rozšíření Git LFS (Large File Storage).

Vytvoření důležitých souborů Gitu, například .gitignore

Git podporuje .gitignore soubory, které pomáhají vynucovat zásady souborů správy verzí. Tyto soubory definují vzory hledání používané k vyloučení souborů a složek ze sledování správy zdrojového kódu. Následující jednoduchý příklad rekurzivně vylučuje všechny složky s názvem Bin nebo bin a jejich obsah ze sledování správy zdrojového kódu:

[Bb]in/

Další informace o ignorování souborů. Můžete si také prohlédnout kolekci počátečních .gitignore souborů nabízených pro různé platformy v úložišti Gitignore.

V projektech GitHubu se běžně používá několik dalších souborů, které uživatelům a přispěvatelům úložišť vysvětlují různé zásady. I když je váš projekt privátní a omezený na úzké publikum, přesto může být užitečné tyto zásady výslovně vyjádřit. I když se žádný z těchto souborů nevyžaduje, uvádíme zde několik běžných souborů.

Soubor	Účel
README.md	Cílová stránka pro adresář. Tato stránka se zobrazí při prohlížení jejího adresáře na GitHubu.
LICENSE.md	Licence, kterou kód poskytuje, najdete v části.
CONTRIBUTING.md	Vysvětluje, jak by uživatelé měli přispívat k projektu, jako jsou očekávání žádostí o přijetí změn.
SECURITY.md	Vysvětluje zásady zabezpečení projektu. Poskytuje pokyny pro uživatele, kteří chtějí odeslat citlivý kód související se zabezpečením nebo zpětnou vazbu, která by neměla být veřejně zpřístupněna před vyřešením.

Přečtěte si další informace o nastavení projektu pro optimální přispívání.

Import projektu do GitHubu

Jakmile připravíte úložiště na migraci, přejděte na kartu Kód úložiště GitHub. K určení zdrojového úložiště použijte možnost Import code (Importovat kód).

O zbytek se postará nástroj GitHub Migrator.