Miten siirrän olemassa olevan projektin GitHubiin?

Valmis

Tässä käsittelemme tärkeitä huomioon otettavia seikkoja, kun projekti siirretään GitHubiin vanhasta versiontarkistusjärjestelmästä.

Miksi siirtyä GitHubiin?

GitHubin hyveitä ylistää kirjallisuusmäärä. Moduulin sisältö ei ylitä sinua muuttamaan. Voimme kuitenkin kertailla joitakin tärkeimpiä etuja, jotka liittyvät aiheiden kontekstiin, jotka on otettava huomioon siirtoa suunniteltaessa.

Versionhallinta

GitHub käyttää yksinomaan Git, joka on kiistatta paras versionhallintajärjestelmä. Git on kuitenkin uskomattoman hienostunut ja voi esittää monimutkaisia skenaarioita koodityöskenaarioiden käsittelemiseksi, joiden kanssa tiimisi ei ehkä ole kokenut. Haarat ja pull-pyynnöt ovat olennainen osa Gitiä käyttävien kehittäjien jokapäiväistä elämää, joten niiden tehokkaan käytön ymmärtäminen ja käyttäminen on tarpeen GitHubissa menestymisen kannalta. Kannattaa, että tiimisi tutustuu ensin GitHub-työnkulkua, jotta pääset alkuun.

Koodin säilyttäminen pilvipalvelussa

Suuri osa projektikoodista tallennetaan edelleen vanhoihin versiontarkistusjärjestelmiin yrityksen palomuurien taakse. Kun siirryt GitHubiin, siirrät koodisi GitHubin pilviympäristöön, jossa tiimin jäsenet voivat käyttää sitä helposti mistä tahansa. Tämä siirto tarjoaa hyvän mahdollisuuden tarkistaa tiimisi käytäntöjä sille, millaisia tiedostoja ja tietoja säilytät versionhallinnassa. Parhaana käytäntönä on olettaa, että kaikki GitHubiin sitoutuvat tiedot vaarantuvat. Älä sisällytä luottamuksellisia tietoja, kuten ohjelmointirajapinta-avaimia, salasanoja tai muita vastaavia tietoja sisältäviä tiedostoja.

Muistiinpano

GitHub tarjoaa sekä julkisia että yksityisiä säilöjä sekä eriytettyjä käyttöoikeuksien valvontatoimintoja säilön eri osien osalta. Tämän avulla voit hallita sitä, ketkä projektit näkyvät, sekä mitä toimintoja tietty käyttäjä voi suorittaa.

Yhteistyö

GitHub tarjoaa erinomaisen tuen tiimiyhteistyölle eri ominaisuuksien, kuten ongelmien, pull-pyyntöjen ja kooditarkistusten kautta. GitHub-työnkulku saattaa kuitenkin poiketa käytännöistä, joihin tiimisi on tällä hetkellä tottunut. On hyvä harkita, aikooko tiimi sopeutua GitHubiin, säilyttää annetun prosessinsa vai tavata jossain keskellä ennen siirron valmistumista.

Jos projektisi on avoimen lähdekoodin projekti, joka sallii ulkopuolisten osallistujien, ei ole olemassa parempaa vaihtoehtoa kuin GitHub etujen maksimoimiseen.

Siirtyminen GitHubiin

Suunnittelussa huomioitavat seikat

Tärkein huomioitava seikka ennen GitHubiin siirtymisen suorittamista on se, pitääkö sinun säilyttää mitään muuta kuin lähteesi nykyinen tila. Jos olet tyytyväinen aloittaessasi uuden projektin käyttäen vain nykyistä lähdekoodiasi as-is, paras vaihtoehto on kohdella sitä kuin uutta projektia ja ladata lähde säilöösi.

Jos kuitenkin haluat säilyttää versionhallintahistorian, sinun on tuotava käyttämällä GitHub Migrator -työkalua. Lisätietoja eri versiontarkistusympäristöjen tuonnin tuesta on Tietojen tuominen kolmannen osapuolen versiontarkistusjärjestelmistä.

Git-tietojen lisäksi saatat myös haluta säilyttää ongelmia, pull-pyyntöjä tai muita tietoja. Näiden kohteiden tuki vaihtelee ympäristön mukaan, ja se on yleisesti saatavilla yhteisöprojekteista. Tämä moduuli ei kata muiden kuin Git-tietojen siirtämistä.

Projektiin tällä hetkellä tallennettujen binaaritiedostojen käsittely

Parhaana käytäntönä GitHub-säilöt tulee rajata projekteissa tarvittaviin tiedostoihin. Vältä suurten binaaritiedostojen, kuten koontiarteaktien, vahvistamista. Binaaritiedostot, kuten laskentataulukot ja esitykset, sopivat paremmin seurantaan portaaleissa, jotka osaavat tarjota ja versioida ne oikein. Jos haluat versioida suuria binaaritiedostoja, harkitse Git LFS (Large File Storage) Git -laajennusta.

Tärkeiden Git-tiedostojen, kuten .gitignoren, luominen

Git tukee .gitignore tiedostoja, joiden avulla voit pakottaa versionhallintatiedostojen käytännöt. Nämä tiedostot määrittävät hakutavat, joita käytetään suljettaessa tiedostoja ja kansioita lähteen hallinnan seurannasta. Seuraava yksinkertainen esimerkki jättää rekursiivisesti pois kansiot, joita kutsutaan Bin tai lokeron, ja niiden sisällön lähteen hallinnan seurannasta:

[Bb]in/

Voit lukea lisätietoja siitä, Ohita tiedostot. Voit myös tutustua eri ympäristöille tarjottavien .gitignore aloitustiedostojen kokoelmaan Gitignore-säilössä.

GitHub-projekteissa käytetään usein useita muita tiedostoja, joiden avulla eri käytännöt selitetään säilön kuluttajille ja osallistujille. Vaikka projektisi olisi yksityinen ja rajattu rajoitetulle kohderyhmälle, nämä käytännöt kannattaa silti nimenomaisesti ottaa huomioon. Vaikka mitään näistä tiedostoista ei tarvita, listasimme muutamia yleisiä tässä.

Tiedosto	Tarkoitus
README.md	Hakemiston aloitussivu. Tämä sivu hahmonnetaan, kun sen hakemistoa tarkastellaan GitHubissa.
LICENSE.md	Käyttöoikeus, johon koodi on annettu.
CONTRIBUTING.md	Kertoo, miten käyttäjien tulisi osallistua projektiin, kuten pull-pyyntö-odotukset.
SECURITY.md	Tässä artikkelissa selitetään projektin suojauskäytäntö. Antaa ohjeita käyttäjille, jotka haluavat lähettää arkaluontoista tietoturvaan liittyvää koodia tai palautetta, jota ei tule julkistaa ennen osoitetta.

Lue lisätietoja Projektin määrittäminen terveille panoksille.

Projektin tuominen GitHubiin

Kun olet valmisteltava säilön siirtämistä varten, siirry GitHub-säilön -välilehteen. Määritä lähdesäilö Tuontikoodin -asetuksen avulla.

GitHub Migrator -työkalu hoitaa loput.