Konfiguraatio

Ennen kuin voit käyttää gittiä versionhallintaan, sinun on pakko asettaa vähintään seuraavat kaksi (tietokoneen skoopissa) globaalia asetusta. Vaihdathan lainausmerkkien sisälle omat tietosi.

git config --global user.name "Etunimi Sukunimi"
git config --global user.email "etunimisukunimi@kamk.fi"

Tiedot tallentuvat globaaliin konfiguraatiotiedostoon kotikansiossasi. Tiedosto on ~/.gitconfig.

Konfiguraatioiden tarkistaminen

Lokaalit eli yhden git-repositorion sisäiset asetukset saa näkyville alla olevalla komennolla. Tämä komento kuuluu ajaa siis kansiossa, jossa sinulla on git-versionhallittu projekti, kuten vaikkapa ~/Code/sukunimi/amazingproject/. Nämä löytyvät tiedostosta <äskeinenkansio>/.git/config

git config --local --list

Koko järjestelmätason oletukset, joiden pohjalta uuden projektin lokaali konfiguraatio muodostetaan, löytyy Windowsilla polusta C:\Program Files\Git\etc\gitconfig. Ne voi tulostaa seuraavalla komennolla:

 git config --system --list

Koko järjestelmätason omat asetukset, joita juuri äsken asetit kaksi (user.name ja user.email), löytyvät tiedostosta ~/config, jossa aaltomerkki edustaa sinun kotikansiotasi (eli C:\Users\username\). Nämä voit tarkistaa komennolla:

git config --global --list

Suositellut konfiguraatiot

Gittiä voi konfiguroida monin tavoin. Alla on esiteltynä muutama, äärimmäisen suositeltu konfiguraatio.

Rivinvaihdot

Windowsissa rivinvaihto - eli enterin painaminen tekstitiedostoa muokatessa - kirjoittaa tiedostoon kaksi merkkiä: CR ja LF, jotka tunnetaan nimillä Carriage Return ja Line Feed. UNIX-pohjaisissa käyttöjärjestelmissä käytetään vain toista merkkiä eli LF. Tämä usein on jo valmiiksi Git for Windows -asennuksessa oikein asetettuna. Alla oleva konfiguraatio asettaa rivinvaihdot siten, että ne ovat sinun koneellasi sinun käyttöjärjestelmälle tutussa formaatissa. Tämä on usein hyvä default. Lue alta poikkeus.

# Windows
git config --global core.autocrlf true

# Linux tai macOS
git config --global core.autocrlf input

Poikkeustilanne: hostin ja kontin väliset eroavaisuudet

Yllä olevaan konfiguraatioon löytyy poikkeustilanne. Tämä tarkoittaa, että jos työskentelet Windowsisssa siten, että kirjoittamasi koodi ajetaan UNIX-pohjaisessa ympäristössä (esim. Docker-kontti, Linux-virtuaalikone), on tärkeää varmistaa, että rivinvaihdot ovat LF-muodossa. Muutoin siirrät kontin sisään (esim. mountilla -v <host_path>:<container_path>) tiedostoja, joissa rivinvaihdot ovat väärässä muodossa. Koodin suoritus tulee kaatumaan. Aloita luomalla projektikansiosi juureen seuraavanlainen konfiguraatiotiedosto, jonka nimi on pakko olla .gitattributes. Lisää vähintään ensimmäinen rivi, kuten alla neuvottu, ja tarpeen mukaan sille poikkeuksia, kuten on myös neuvottu koodisnippetissä.

.gitattributes

# Lisää tämä rivi tiedostoon:
* text=auto eol=lf

# Jos jonkin tiedoston on pakko olla Windows-rivinvaihdollinen,
# lisää sille poikkeuksia näin:
*.bat eol=crlf
*.ps1 eol=crlf
# ... jne ....

Seuraavaksi pakota VS Code käyttämään tätä konfiguraatiota. Avaa VS Code ja luo projektiisi uusi tiedosto polkuun .vscode/settings.json. Tämä tiedosto on VS Codelle viesti, että haluat käyttää projektikohtaisia poikkeusasetuksia. Lisää tiedostoon seuraavat rivit:

.vscode/settings.json

{
    "files.eol": "\n"
}

Näin olet pakottanut VS Coden käyttämään UNIX-tyylistä rivinvaihtoa. Tämä muutos ei koska olemassaolevia tiedostoja. Kenties helpoin tapa korjata tämä on:

1. Lisää tuoreet muutokset gittiin (git add, commit, push)
2. Tuhoa koko hakemisto
3. Kloonaa projekti uusiksi, jolloin muutokset tulevat voimaan.s

Vältä jatkossa muokkaamasta kyseisen projektin tiedostoja muilla ohjelmilla kuin VS Codella.

Pullin strategia

Mikäli ajat komennon git pull tai git pull origin main ennen omaa git push-komentoa, aiheutat herkästi odottamattomia committeja. Lue lisää aiheesta täällä: Why You Should Use git pull --ff-only | sffc's Tech Blog. Hyvä yleisvarma tapa ratkaista ongelma on asettaa seuraava konfiguraatio paikoilleen:

git config --global pull.ff only

Tekstieditori

Kun luot esimerkiksi git commitin komennolla git commit, aukeaa tekstieditori. Tämä editori on todella usein vakiona vi tai vim, mikä saattaa olla aloittelijan silmissä hankala työkalu. Voit vaihtaa sen huomattavasti helpompaan nano-nimiseen ohjelmaan näin:

git config --global core.editor "nano"

Oletushaaran eli branchin nimi

Git käyttää vakiona yhä master-nimistä (tarkista: git config --system init.defaultBranch) nimeä vakiohaaralle, joka luodaan kun teet kansiosta git-versionhallitun projektin käskyllä git init. Tämä on ongelmallinen kahdesta syystä:

1. Inklusiivisuus. Master-sanalla on huono historia.
2. Käytännöllisyys. GitHub, GitLab ja muut git-palvelua tuottavat yritykset ovat siirtyneet pitkälti main-nimeen. On käytänöllistä pitää heti alusta alkaen oma repositorio samankaltaisena kuin heidän oletuksensa.

Oletuksen voi vaihtaa seuraavalla komennolla:

git config --global init.defaultBranch main