Git ja GitHub IDE-s: commitist Pull Requestini
Saad teada, mis on commit, kohalik repositoorium ja GitHub ning kuidas need omavahel seotud on. Seejärel läbid IDE-s praktilise töövoo: kloonid meeskonna repositooriumi (Clone), lood uue haru, lisad testjuhtumi, teed commiti ja pushi, lood Pull Requesti, osaled selle ülevaatuses ja ühendad muudatused (Merge). Lõpuks uuendad oma lokaalset projekti (Update Project), et saada kätte meeskonna viimased muudatused.
Tootest
Tere! Meie meeskond hoiab testjuhtumeid mitte tabelis, vaid GitHubi Git-repositooriumis, koodi kõrval. Nii on näha, kes, millal ja mida muutis, ja iga muudatus läbib ülevaatuse. Sinu ülesanne on lisada uus testjuhtum: sisselogimise lukustus pärast kolme vale parooli.
Kõlab huvitavalt! Kuidas seda teha?
Pull Requesti kaudu, nagu kõik meeskonnas. Kadri näitab kogu tee: laadid repositooriumi alla, lood haru, teed commiti, saadad selle GitHubi, avad Pull Requesti, läbid ülevaatuse ja liidad muudatused main-harusse.
Tere! Teeme kõik IDE-s: nuppudega, ilma käskudeta. Aga kõigepealt üldpilt: kus projekt asub ja kuidas sinu muudatused kolleegideni jõuavad.
Tere, Kadri! Kuidas see kõik töötab?
Igal meeskonnaliikmel on oma arvutis projekti koopia, ühine versioon asub aga GitHubis. Muudatused liiguvad nende vahel mööda nooli:
Sinu arvuti
GitHub — ühine baas
projekti versioon, mida näeb kogu meeskondPull Request · reviewKolleegid
igaühel oma koopiaCommit
Salvestuspunkt nagu mängus: failide hetktõmmis koos kirjelduse, autori ja ajaga. Iga commiti juurde saab tagasi minna ja alati on näha, kes mida muutis.
Kohalik repositoorium
Projekt sinu arvutis koos kogu commitide ajalooga. Commit jõuab kõigepealt siia: kolleegid seda ei näe ja internetti selleks vaja pole.
GitHub — ühine baas
Meeskonna kaugrepositoorium, Git nimetab seda origin. Push saadab sinna sinu commitid, pull toob sealt kolleegide commitid. Siin toimuvad ka Pull Requestid ja ülevaatused.
IDE
IDE on programm projekti failidega töötamiseks. Git on sinna sisse ehitatud: käskude asemel on nupud, aga kapoti all käivituvad samad Giti käsud.
Kontrollime. Tegid just commiti. Kus see praegu on?
Selge! Mis veel teel ette tuleb?
Veel mõned sõnad, mida täna vaja läheb:
Sõnastik
clone— laadida repositoorium GitHubist oma arvutisse. Seda tehakse üks kord, projektiga töö algusesharu(branch) — eraldi töösuund. Peamine harumainon kontrollitud versioon ja iga ülesande jaoks luuakse oma harupush— saata oma commitid GitHubipull— tuua GitHubist uued commitid. IDE-s on selle nupu nimi Update ProjectPull Request (PR)— taotlus liita sinu harumain-harusse: kolleegid vaatavad muudatused enne liitmist üle
Kolleeg tahab sinu commiti näha. Mida teha?
Kõik selge! Avan IDE.
Töökoht
Samm 1 · Kloonimine
Kõigepealt toome projekti sinu arvutisse. Selleks repositoorium kloonitakse: Git laadib GitHubist alla kõik failid ja kogu ajaloo ning sul tekib oma kohalik repositoorium.
Kuidas seda IDE-s teha?
Vajuta IDE all olevas GitHubi aknas rohelist nuppu Code ja kopeeri aadress. Seejärel vali IDE tervitusekraanil Get from VCS, kontrolli aadressi ja vajuta Clone.
Vihje
Kuhu vajutada:
GitHub: Code → ⧉ IDE: Get from VCS → Clone
Sama terminalis:
git clone https://github.com/bb-food/shop-tests.git
Töökaust
Commitiks märgitud
☑Kohalik repositoorium
CommitGitHub (origin)
PushIDEDevelopment environment
- Projects
- Customize
- Plugins
- Learn
Welcome to the IDE
Create a new project to start from scratch.
Open existing project from disk or version control.
Valmis! IDE laadis projekti alla ja avas selle: vasakul on failipuu ja all Giti aken commitide ajalooga. Skeemil ilmusid failid töökausta ja kohalikus repositooriumis on main-haru kahe commitiga. Vaata allosas vahekaarti Console: IDE käivitas sama käsu git clone, mida terminali sisestatakse.
Mida teeb Clone?
Kas võin kohe faili muuta?
Samm 2 · Uus haru
Peaaegu. main-harus on kontrollitud versioon, mida kasutab kogu meeskond, seega sinna otse ei kirjutata. Iga ülesande jaoks luuakse oma haru: seal saab rahulikult töötada teisi segamata.
Kuidas haru luua?
Vajuta IDE ülaribal haru nimele main ja vali New Branch… Sisesta nimi test/login-lockout ja vajuta Create. Linnuke Checkout branch lülitab sind kohe uuele harule.
Vihje
Kuhu vajutada:
⎇ main ▾ → New Branch… test/login-lockout → Create
Sama terminalis:
git switch -c test/login-lockout
Oled harus test/login-lockout: selle nimi on nüüd ülaribal ja olekuribal. Praegu on haru lihtsalt uus silt samal commitil, kus main. Kõik, mida edasi commitid, läheb ainult sinna.
Enne commiti vaata alati ülaribalt haru nime. Commit valesse harusse on algajate kõige sagedasem viga.
Miks luua ülesande jaoks eraldi haru?
Nüüd kirjutan testjuhtumi!
Samm 3 · Muudatused
Jah! Ava sisselogimise lukustuse testjuhtumite fail ja lisa uus juhtum. Git märkab kohe, et fail muutus, kuid ise muudatust ajalukku ei salvesta.
Kuidas näha, mida Git märkas?
Vajuta redaktoris „Lisa testjuhtum TC-02“ ja ava siis vasakul aken Commit (külgriba teine ikoon). Sinna on kogutud kõik muudetud failid — sama näitab käsk git status.
Vihje
Kuhu vajutada:
Redaktor: „Lisa testjuhtum TC-02“ Külgriba: Commit
Sama terminalis:
git status
Fail on nimekirjas Changes ja IDE näitab seda sinisena — projektipuus, vahekaardil ja Commit-aknas. Rohelised ribad reanumbrite kõrval tähistavad uusi ridu. Kuid failil pole veel linnukest: see on muudetud, aga commitiks valimata.
Fail on nimekirjas Changes, aga ilma linnukeseta. Kas see läheb commitisse?
Kuidas faili valida?
Samm 4 · Failide valimine
Gitis on indeks (staging area) — järgmise commiti „korv“. Sina otsustad, mis sinna läheb: terminalis on selleks käsk git add, IDE-s aga linnuke faili kõrval. Kui muutsid viit faili, aga ülesandega on seotud kaks, märgi ainult need.
Kuhu linnuke panna?
Pane Commit-aknas linnuke faili login-lockout.md juurde.
Vihje
Kuhu vajutada:
Commit → Changes → ☑ login-lockout.md
Sama terminalis:
git add test-cases/login-lockout.md
Fail on commitiks valitud: skeemil liikus see teise veergu. Kõik märgitu läheb commitisse, märkimata jääb töökausta.
Nüüd commit?
Samm 5 · Commit
Jah. Commit salvestab märgitud muudatused ajalukku hetktõmmisena: koos autori, aja, unikaalse numbri (räsi) ja kirjeldusega. Hea kirjeldus ütleb lühidalt, mis tehti. Meeskondades kirjutatakse see tavaliselt inglise keeles.
Kuhu kirjeldus kirjutada?
Kirjuta väljale Commit Message kirjeldus Add TC-02 login lockout test case ja vajuta Commit.
Vihje
Kuhu vajutada:
Commit Message: Add TC-02 login lockout test case Commit
Sama terminalis:
git commit -m "Add TC-02 login lockout test case"
Commit on loodud: see ilmus allosas aknasse Git → Log oma räsiga ja fail pole enam sinine. Aga pane tähele: commit on olemas ainult sinu kohalikus repositooriumis. GitHubis ei näe seda veel keegi.
Tegid commiti. Kas kolleegid näevad seda GitHubis?
Kuidas see GitHubi saata?
Samm 6 · Push
Push saadab sinu haru commitid GitHubi. GitHubis pole haru test/login-lockout veel olemas, kuid IDE märkab seda ja loob selle ise.
Kus see nupp on?
Vajuta IDE ülaribal noolt Push (↗). Kontrolli aknas Push Commits, et haru läheb sihtkohta origin : test/login-lockout märkega New, ja vajuta Push.
Vihje
Kuhu vajutada:
Ülariba: ↗ Push Push Commits → Push
Sama terminalis:
git push -u origin test/login-lockout
Haru ja commit on nüüd GitHubis: vaata neljandat veergu. GitHub märkas uut haru ja pakub kohe Pull Requesti avamist. Vahekaardil Console on näha käsk git push --set-upstream origin test/login-lockout: IDE sidus sinu haru GitHubi haruga sinu eest.
Mille poolest erinevad Commit ja Push?
Avan Pull Requesti!
Samm 7 · Pull Request
Pull Request on palve: „vaadake mu muudatused üle ja liitke haru main-harusse“. PR-is on näha kõik commitid ja muudatused rea kaupa, kolleegid jätavad kommentaare ja automaatkontrollid (CI) käivitavad testid.
Mida PR-i kirjutada?
Vajuta GitHubi aknas Compare & pull request. Kontrolli, et liidad haru test/login-lockout harusse main, ning anna selge pealkiri ja kirjeldus: mis tehti ja miks. Seejärel vajuta Create pull request.
Vihje
Kuhu vajutada:
GitHub: Compare & pull request Create pull request
PR on avatud ja kontrollid läbitud. Kuid ma jätsin kommentaari ja palusin muudatusi (Changes requested): TC-02-l pole oodatavat tulemust. See on töö tavaline osa: ülevaatus ongi selleks, et selliseid asju enne liitmist leida.
Testijale on PR oluline infoallikas: vahekaardil Files changed on näha, mis täpselt muutus, ja selle järgi on mugav testimist planeerida.
Miks kasutab meeskond Pull Requesti, selle asemel et harud kohe liita?
Kuidas kommentaar parandada?
Samm 8 · Parandus pärast ülevaatust
Uut PR-i pole vaja avada. Piisab, kui lisad samasse harusse uue commiti ja saadad selle: PR jälgib haru ja uueneb ise.
Kas korrata samu samme?
Jah, sama tsükkel. Vajuta redaktoris „Lisa oodatav tulemus“, märgi fail linnukesega, kirjuta kirjeldus Add expected result to TC-02 ja vajuta Commit and Push… — nii tehakse commit ja push korraga. Vajuta aknas Push Commits nuppu Push.
Vihje
Kuhu vajutada:
Redaktor: „Lisa oodatav tulemus“ ☑ login-lockout.md Commit Message: Add expected result to TC-02 Commit and Push… → Push
Sama terminalis:
git add test-cases/login-lockout.md git commit -m "Add expected result to TC-02" git push
Uus commit ilmus PR-i, kontrollid läbiti uuesti ja ma kinnitasin muudatused (Approved). Nüüd võib PR-i liita.
Ülevaataja palus PR-i parandada. Mida teha?
Liidan!
Samm 9 · Merge
Liitmine (merge) toob haru commitid main-harusse. Meil on kinnitus ja rohelised kontrollid — kõik, mida meeskonna reeglid nõuavad.
Kus see nupp on?
Vajuta GitHubis Merge pull request ja seejärel Confirm merge.
Vihje
Kuhu vajutada:
GitHub: Merge pull request → Confirm merge
PR on liidetud: sinu testjuhtum on nüüd GitHubis main-harus ja kogu meeskond näeb seda. Haru test/login-lockout võib GitHubis kustutada, töö selles on tehtud.
PR on GitHubis liidetud. Kas uus testjuhtum on sinu arvuti main-harus?
Kuidas main-haru uuendada?
Samm 10 · Update Project
Mine tagasi main-harule ja too muudatused GitHubist. IDE-s on selleks Update Project (sinine nool ↙): see laadib alla uued commitid ja lisab need praegusesse harusse nagu git pull. Nii tehakse enne iga uut ülesannet.
Kuidas seda teha?
Vajuta ülaribal haru nimele, vali main ja vajuta Checkout. Vaata redaktorit. Seejärel vajuta Update Project (↙) ja aknas OK.
Vihje
Kuhu vajutada:
⎇ test/login-lockout ▾ → main → Checkout Ülariba: ↙ Update Project → OK
Sama terminalis:
git switch main git pull
Kohalik main jõudis GitHubile järele: selles on sinu commitid ja liitmiscommit. Muide, kohe pärast lülitumist polnud failis uut testjuhtumit: sinu arvuti ei teadnud veel GitHubis tehtud liitmisest. Git ise võrgus ei käi, seepärast vajutatakse enne tööd alati Update Project.
Aitäh, Kadri!
Läbisid muudatuse kogu tee meeskonnas: Clone → New Branch → linnuke → Commit → Push → Pull Request → ülevaatus → Merge → Update Project. See tsükkel kordub igas ülesandes. Terminalis tehakse sama käskudega git clone, git switch -c, git add, git commit, git push ja git pull.
Lühiviide
Git ja GitHub
Git on versioonihaldussüsteem arvutis: see hoiab failide muudatuste ajalugu. GitHub on meeskonna ühine baas: kaugrepositoorium (origin), kus on projekti versioon kõigi jaoks ning kus toimuvad Pull Requestid ja ülevaatused.
Commit ja kohalik repositoorium
Commit on muudatuste hetktõmmis koos kirjelduse, autori, aja ja räsiga. Kõigepealt jõuab see sinu arvuti kohalikku repositooriumi: kolleegid ei näe seda enne, kui teed pushi.
Harud IDE-s
Praeguse haru nimi on ülaribal. Sellele klõpsates: New Branch… loob haru (linnukesega Checkout branch lülitab kohe sellele) ning haru valimine ja Checkout lülitab olemasolevale harule.
Commit IDE-s
Commit-aken näitab muudetud faile (need on sinised). Linnuke faili juures on indeks (git add): commitisse lähevad ainult märgitud failid. Kirjeldus kirjutatakse väljale Commit Message ja vajutatakse Commit või Commit and Push….
Push ja Update Project
Push (↗) saadab haru commitid GitHubi; uue haru loob IDE seal ise. Update Project (↙) laadib GitHubist uued commitid praegusesse harusse nagu git pull. Git ise võrgus ei käi.
Pull Request ja ülevaatus
PR on taotlus liita haru main-harusse. Selles on näha commitid ja muudatused rea kaupa (Files changed), käivad automaatkontrollid (CI) ning kolleegid kinnitavad (Approve) või paluvad parandusi (Request changes). Parandused on uued commitid samasse harusse.
IDE ja terminal
Get from VCS = git clone, New Branch = git switch -c, linnuke = git add, Commit = git commit, Push = git push, Update Project = git pull. Milliseid käske IDE käivitas, näeb vahekaardil Git → Console.