Git & Github 실무 활용 완벽 가이드 part1. (Git 기초 및 커밋)

 

도커 강의와 함께 신청한 유데미 강의, Git & Github 실무 활용 완벽 가이드 

이전에 깃과 깃헙을 거의 사용하지 않아 깃이나 깃헙을 사용할 줄 아는 건 레포 만들고 파일들 올리고 깃 클론하는 게 전부였다... 그러나 깃, 깃헙을 사용하여 협업하는 곳이 정말 많으므로 이번 기회에 기본을 배워보고자 이 강의를 선택하였다.

강의의 내용들이 섹션별로 작게 쪼개져 있어 한두 페이지의 글로 내용들을 정리할 수 있을 것 같다.

 

 

 

 

---

 

 

 

섹션 2 : Git 소개

Git이란?

• 깃은 전세계에서 널리 사용되고 있는 버전 관리 시스템으로, 협력과 변화의 공유가 주 특징이다. 사용자와 개발자, 작성자 간의 협력을 가능하게 하고 누구든 깃으로 작업하는 사람들이 각 개인들 간에 벌어지는 여러 변화와 수정사항들을 서로 공유할 수 있도록 도와준다.
• 깃은 체크포인트 설정이 가능하도록 해준다. 작업의 중간중간마다 체크포인트를 두고 버전을 설정하여 원하는 시점으로 롤백하거나 이동하거나 혹은 한 체크포인트에서 다른 방향으로 개발도 가능하게 한다. 혹은 체크포인트들을 결합하기도 한다.

 

 

Git vs Github

• Git ≠ Github
• Git
  • 버젼 관리 소프트웨어. 컴퓨터에서 실행되며 인터넷이나 계정 등록이 필수가 아니다. MS Word나 Excel 같은 문서 프로그램처럼 그저 사용하는 일종의 프로그램이다.
• Github
  • 웹서비스. 깃 허브는 깃 저장소가 필요하며 클라우드에 소스 코드들을 저장해서 다른 사람과 쉽게 공동으로 작업할 수 있도록 해준다. 웹사이트 기 때문에 계정과 인터넷이 필요하다.
  • 깃을 사용해 내가 작업한 내용들을 깃허브에 업로드하여 공유 및 게시할 수 있으며 다른 사람들은 이 코드와 깃프로젝트를 각자의 컴퓨터로 가져갈 수 있다. 

 

 

---

섹션 3 : 설치 및 설정

Git 설치 및 설정하기

• 주 사용환경은 윈도우므로 윈도우를 기준으로 진행하였다. 설치 페이지에서 맞는 비트의 윈도우 버전을 다운로드하여 설치해주면 끝. 
• 설치 후엔 Git 이름과 이메일을 먼저 설정해줘야한다.

userpc@DESKTOP-UQ5OHLV MINGW64 ~
$ git config user.name

userpc@DESKTOP-UQ5OHLV MINGW64 ~
$ git config --global user.name "bh lee"

userpc@DESKTOP-UQ5OHLV MINGW64 ~
$ git config user.name
bh lee

---

userpc@DESKTOP-UQ5OHLV MINGW64 ~
$ git config user.email

userpc@DESKTOP-UQ5OHLV MINGW64 ~
$ git config --global user.email "lbh1224@gmail.com"

userpc@DESKTOP-UQ5OHLV MINGW64 ~
$ git config user.email
lbh1224@gmail.com

 

 

 

 

---

섹션 4 : Git의 기초. 

+섹션 5 : 커밋과 관련 주제 자세하게 알아보기

섹션 4와 섹션 5, 두 섹션은 커밋에 대해 내용을 다루므로 함께 정리하였다. 

 

Git Repo 만들기

• 깃을 사용하기 전에 먼저 레포라 흔히 부르는 Repository를 만들어줘야 한다.
• 언제, 어느 디렉토리에 저장소를 만들어야 하는지 깃에게 수동으로 지시해주는 것으로 저장소들, 모든 레포들은 고유 이력을 갖고 있으며 서로 관련이 없는 독립적인 성격을 갖고 있다.
• 깃을 사용하고 싶다면 각각의 프로젝트 폴더로 이동해서 깃 저장소를 생성한 뒤에 명령어를 사용해야 한다.

 

 

Git Init & Git Status

 

git status

• 현재 위치한 레포의 상태를 보고해주는 명령어.
• 레포가 아직 없다면 아래처럼 not a git repository, 깃 저장소 정보가 없다고 뜬다. 

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads
$ git status
fatal: not a git repository (or any of the parent directories): .git

 

 

git init

• 새 레포의 홈으로 설정하는 명령어. 현재 위치한 디렉토리를 새로운 깃 저장소로 실체화한다. 이 명령어는 레포를 만들때 최초에만 사용한다.
• git init 명령어를 통해 빈 깃 저장소를 생성하거나 기존 저장소를 다시 초기화할 수 있다. 빈 깃 저장소를 생성할 때 .git 이라는 숨겨진 하위 디렉토리를 생성한다.
• 깃 디렉토리가 .git 이렇게 숨겨진 형태인 이유는 만약 이력이 있는 디렉토리를 삭제하게 된다면 모든 자료들을 잃어버릴 수 있기 때문이다. 
• 위에서 언급했듯이 git init은 새로운 깃 저장소를 만듬과 동시에 기존의 저장소를 초기화하기 때문에 여러개의 프로젝트를 관리할 때 항상 git status를 실행해서 먼저 확인하는 것이 중요하다. .git 폴더를 삭제하는 것은 저장소를 초기화하는 것과 동일하다. 

git init 

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test
$ git init
Initialized empty Git repository in C:/Users/userpc/Downloads/git_study/test/.git/

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ git status
On branch master

No commits yet

nothing to commit (create/copy files and use "git add" to track)

 

 

.git directory

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ ls

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ ls -a
./  ../  .git/

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ cd .git/

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test/.git (GIT_DIR!)
$ ls
HEAD  config  description  hooks/  info/  objects/  refs/

 

 

---

 

 

Git Add & Commit 

• 커밋 워크플로우 개요
  • 깃 커밋은 깃 레포에 있는 체크포인트들 중 하나로 보통 하나의 저장소에 어마하게 많은 커밋들이 존재한다. 아주 중요한 점은 커밋은 파일을 저장하는 것과 같은 것이 아니라는 점이다. 파일을 저장하는 것 이상으로 어떤 것을 구축한다는 의미이다.
  • 커밋하기 전에 먼저 수정해서 파일에 저장해야 하며, 아래의 사진 예제처럼 변경사항이 있으면 그것들을 묶어서 커밋할 수 있다. 
  • 워크 플로우에는 3가지 영역이 있다.
    • 워킹 디렉토리 : 프로젝트에서 실제로 작업하는 공간, 디렉토리.
    • 스테이지 영역 : 커밋하기 전에 변경사항들을 등록하는 곳
    • 저장소 : .git 폴더. 커밋을 하게 되면 git commit은 .git 안에 있는 것들을 변경하여 새 커밋을 폴더에 등록한다. 그래서 커밋하면 그 폴더, 사실은 깃 저장소를 업데이트 하는 것이다.

 

 

• Git add로 변경사항 스테이징하기 
  • 어떤 작업을 하고 나서 생긴 변경사항을 커밋하기 전에 먼저 add 명령어를 통해 스테이지에 올리는 단계를 거쳐야 한다. 

git commit workflow

 

간단한 예제로 git init을 통해 새로운 레포를 만들고 characters.txt, outline.txt 두 개의 텍스트 파일을 만든 뒤에 git staus를 쳐보면 아래와 같은 결과가 나온다.

깃은 2개의 파일을 인식하고 있지만 추적하고 있지 않다고 보여준다. 

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ git status
On branch master

No commits yet

Untracked files:
  (use "git add <file>..." to include in what will be committed)
        characters.txt
        outline.txt

nothing added to commit but untracked files present (use "git add" to track)

 

 

git add를 이용해 두 텍스트파일을 add 하면

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ git status
On branch master

No commits yet

Changes to be committed:
  (use "git rm --cached <file>..." to unstage)
        new file:   characters.txt
        new file:   outline.txt

 

커밋하기 전, 스테이지에 올라가 있는 상태가 된다.

 

 

Git 커밋 메세지

• 깃을 커밋할 때는 커밋 메세지를 같이 적을 수 있다. 커밋할 때마다 변경사항을 요약하거나 묘사하는 메세지를 포함하는 것이 좋다.
• git commit -m “my message”

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ git commit -m "start work on outline and main characters"
[master (root-commit) fb4ec81] start work on outline and main characters
 2 files changed, 2 insertions(+)
 create mode 100644 characters.txt
 create mode 100644 outline.txt


userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ git status
On branch master
nothing to commit, working tree clean

 

git status를 실행하면 정상적으로 커밋이 처리되었다고 뜬다.

커밋할 때 메세지를 제공하기 위해 git commit -m 명령을 사용할 것을 추천한다. 만약 git commit 명령을 사용했을 때 만약 에디터가 설정되지 않았다면 문제가 발생할 수도 있다.

 

예제에서는 커밋 메세지에 간단하게 한 줄로 적었으나 경우에 따라 여러 줄의 커밋메세지를 통해 작업에 대해 자세한 설명이 필요한 경우도 존재한다. 

작업 후에 커밋할 때 커밋 메세지를 따로 작성하지 않으면 vim 에디터로 커밋메세지를 적으라고 창이 뜨거나 혹은 VSCode를 사용한다면 VSCode로 넘어가기도 한다. 

만약 커밋 메세지 텍스트 에디터가 vim으로 뜰 경우 git config --global core.editor “code --wait” 해당 명령어를 통해 VSCode로 텍스트 에디터를 설정해 줄 수 있다. 

 

여러 줄의 커밋메세지 입력하기

 

 

Git Log 명령어 

# master 브랜치에서 chapter1.txt 파일 새로 생성
userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ touch chapter1.txt

# git status를 통해 변경사항 확인
userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ git status
On branch master
Untracked files:
  (use "git add <file>..." to include in what will be committed)
        chapter1.txt

nothing added to commit but untracked files present (use "git add" to track)

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ ls
chapter1.txt  characters.txt  outline.txt

# characters.txt 파일 수정
userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ vim characters.txt

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ git status
On branch master
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   characters.txt

Untracked files:
  (use "git add <file>..." to include in what will be committed)
        chapter1.txt

no changes added to commit (use "git add" and/or "git commit -a")

 

간단한 예제로 새로운 텍스트 파일 chapter1.txt를 생성하고 characters.txt 파일을 수정하였더니 git status에서 위와 같이 변경사항이 뜬다.

변경사항이 있는 두 파일, chapter1.txt characters.txt를 add를 통해 스테이지에 올리고 커밋 메세지와 함께 커밋하였다.

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ git add chapter1.txt characters.txt
warning: in the working copy of 'characters.txt', LF will be replaced by CRLF the next time Git touches it

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ git status
On branch master
Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
        new file:   chapter1.txt
        modified:   characters.txt


userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ git commit -m "begin work on chapter 1"
[master 6298419] begin work on chapter 1
 2 files changed, 1 insertion(+)
 create mode 100644 chapter1.txt

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ git status
On branch master
nothing to commit, working tree clean

 

이외에도 새로운 파일을 만들거나 수정했을 경우 모든 변경사항은 git status에서 확인할 수 있으며 커밋을 했을 때의 로그들도 아래처럼 확인할 수 있다.

 

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ git log
commit 00f2743ebeed35508a877d9f36de420a3dd9807d (HEAD -> master)
Author: lbh1224 <leehag1224@gmail.com>
Date:   Thu Mar 21 19:08:01 2024 +0900

    split chapter 1 into two pieces

commit 5d2cd9756a67805b1a744e0a76ca050eeb1981ff
Author: lbh1224 <leehag1224@gmail.com>
Date:   Thu Mar 21 19:04:49 2024 +0900

    finish chapter 1

commit 6298419754009b8490fbf80356fd905c9e960ea0
Author: lbh1224 <leehag1224@gmail.com>
Date:   Thu Mar 21 19:01:32 2024 +0900

    begin work on chapter 1

commit fb4ec81f80ae6fa22f94e59bc28abd81984a2d36
Author: lbh1224 <leehag1224@gmail.com>
Date:   Thu Mar 21 18:49:23 2024 +0900

    start work on outline and main characters

 

커밋 내역이 적다면 이렇게 모든 로그를 출력해도 괜찮으나 대부분의 프로젝트의 경우 어마어마한 커밋들이 존재하므로 모든 커밋 로그들을 출력한다면 가독성이 굉장히 안 좋아진다. 따라서 이런 경우 축약, 요약해주는 git log 옵션들을 사용해 주면 좋다.

깃 로그 공식문서의 모든 옵션을 알 필요는 없다. 

 

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ git log
commit a9533bf022b95ff74f79488e85c72818f2dcee80 (HEAD -> master)
Author: lbh1224 <leehag1224@gmail.com>
Date:   Thu Mar 28 20:41:42 2024 +0900

    in outline, i add some sentence
    this is example, commit message
    addjdjdjdjdjdjdj

commit 1c0b4a341d9d5bcfeca8a930ccc9d752e8c98b2d
Author: lbh1224 <leehag1224@gmail.com>
Date:   Thu Mar 28 20:33:04 2024 +0900

    Fix Typo in outline

commit 00f2743ebeed35508a877d9f36de420a3dd9807d
Author: lbh1224 <leehag1224@gmail.com>
Date:   Thu Mar 21 19:08:01 2024 +0900

    split chapter 1 into two pieces

commit 5d2cd9756a67805b1a744e0a76ca050eeb1981ff
Author: lbh1224 <leehag1224@gmail.com>
Date:   Thu Mar 21 19:04:49 2024 +0900

    finish chapter 1

commit 6298419754009b8490fbf80356fd905c9e960ea0
Author: lbh1224 <leehag1224@gmail.com>
Date:   Thu Mar 21 19:01:32 2024 +0900

    begin work on chapter 1

commit fb4ec81f80ae6fa22f94e59bc28abd81984a2d36
Author: lbh1224 <leehag1224@gmail.com>
Date:   Thu Mar 21 18:49:23 2024 +0900

    start work on outline and main characters

-------------------------------after--------------------------------

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ git log --oneline
a9533bf (HEAD -> master) in outline, i add some sentence this is example, commit message addjdjdjdjdjdjdj
1c0b4a3 Fix Typo in outline
00f2743 split chapter 1 into two pieces
5d2cd97 finish chapter 1
6298419 begin work on chapter 1
fb4ec81 start work on outline and main characters

 

이렇게 축약, 요약해서 로그를 보는 경우가 있으므로 커밋 메세지의 첫 번째 줄은 아무리 길더라도 커밋 내용을 요약해야 한다. 첫 번째 라인은 커밋을 요약한다는 패턴은 관례이다.

 

 

.gitignore

• 프로젝트에서 작업하면서 깃을 사용할 때, 갖고 있는 파일이나 디렉토리가 깃에게 알려지거나 추적되지 않고 완벽히 제외되는 것이 필요한 경우가 있다.
• API 키, 패스워드, 토큰 등 보안이 필요하여 공유되어선 안 되는 경우나 깃에 올릴 필요 없고 제외해야 하는 불필요한 경우가 존재한다. 이 때 .gitignore 파일을 만들고 원하는 내용들을 리스트로 작성할 수 있다.

간단한 예제를 통해 설명해 보자면

1. secrets.txt라는 보안상의 내용을 담고 있는 텍스트 파일이 있다. 해당 파일은 깃에 의해 추적되어서도, 커밋되어 공유되어서도 안된다. 하지만 아직까지는 깃의 추적을 받고 있다.

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ vim secrets.txt

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ git status
On branch master
Untracked files:
  (use "git add <file>..." to include in what will be committed)
        secrets.txt

nothing added to commit but untracked files present (use "git add" to track)

 

 

2. .gitignore 파일을 만들어 리스트에 secrets.txt 파일을 추가하였다.

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ touch .gitignore

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ ls -a
./   .git/       chapter1.txt  characters.txt  secrets.txt
../  .gitignore  chapter2.txt  outline.txt

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ vim .gitignore

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ git status
On branch master
Untracked files:
  (use "git add <file>..." to include in what will be committed)
        .gitignore

nothing added to commit but untracked files present (use "git add" to track)

 

위와 달리 git status에서 secrets.txt 파일이 더 이상 깃에 추적되지 않음을 확인할 수 있다.

하지만 .gitignore 파일 자체가 추적되고 있다. .gitignore 파일은 현재로선 커밋될 필요가 없는 파일이므로 이 파일도 제외가 필요하다.

 

3. gitignore 파일에 자기 자신도 리스트에 추가하였다.

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ vim .gitignore

userpc@DESKTOP-UQ5OHLV MINGW64 ~/Downloads/git_study/test (master)
$ git status
On branch master
nothing to commit, working tree clean

이제 더이상 깃의 추적을 받지 않는 것을 볼 수 있다.