[Git] GitHub 레포 CI 관리하기

🦊 CI/CD란?

CI(Continuous Integration)/CD(Continuous Delivery or Deployment)의 기본 개념은 지속적인 통합, 지속적인 서비스 제공, 지속적인 배포 입니다.

CI를 성공적으로 구현할 경우 애플리케이션에 대한 새로운 코드 변경 사항이 정기적으로 빌드 및 테스트되어 공유 리포지토리에 통합되므로 여러 명의 개발자가 동시에 애플리케이션 개발과 관련된 코드 작업을 할 경우 서로 충돌할 수 있는 문제를 해결할 수 있습니다.

CD 설명 보기

참고 사이트

📌 GitHub에 레포에 CI 배지 달기

1. 먼저 레포를 생성해서 로컬에 클론합니다.( 라이센스만 생성)
2. repository settings - Branches - Branch protection rule 로 들어가서

• Require a pull request before merging 체크
• Require status checks to pass before merging 체크
• .github/workflows - lint.yml 파일이 만든 브랜치에서 merge할때
  pull request에서 base : main <- compare : 아래 브랜치 일때 lint 테스트 통과 못하면 fail이 뜨고 merge를 막을 수 있음

3. https://codeclimate.com/ 에 들어가서 우측 상단 login - quality - Open source를 클릭합니다.

4. GitHub로 로그인 후 우측 상단에 Add a repository에서 생성한 레포를 Add Repo합니다.

5. 체크가 완료되면 메뉴에서 Repo Settings - Test coverage 에서 TEST REPORTER ID를 복사해서 메모장에 기록해 두세요

6. ci - example 레포 를 클론해서 내용을 받아옵니다.

7. 내용을 생성한 레포에 복붙합니다.

8. vscode에서 해당 내용을 수정합니다.

   • .github/workflows 의 coverage.yml

   env:
     CC_TEST_REPORTER_ID: codeclimate에서 복사해온 [TEST REPORTER ID]를 복붙해주세요
   
   # 만약 TEST REPORTER ID를 보안사항으로 만들고 싶다면
   env:
     CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
   # 이렇게 적어두고 github repo setting - Secrets - Actions - New repository secret 에서 
   # NAME  : CC_TEST_REPORTER_ID / Value : 복사한 TEST REPOTER ID 를 입력하면 된다.

   
   
   • .vscode의 launch.json

   "version": "0.1.0"
   // version이 바뀔때마다 수정해 주세요
   
   "env": {
       "PYTHONPATH": "${workspaceRoot}/레포지토리_이름"
   }

   
   
   • coverage.xml

   <source>레포의 경로</source>
   
   <!-- example -->
   <source>/Users/krc/Documents/dev/stock_price_downfall_predict</source>

   
   
   • main.py

   ## 원하는 코드들을 lint 에 맞게 적어야 합니다. 
   # 설정한 lint에 따라 코드 작성 기준이 정해집니다.
   # Lint 기준 지정 : 코드-기본설정-설정(cmd + ,) 으로 가서 black, flake8, mypy 등을 체크 
   # 저장시 린트 자동 적용 : cmd + , 에서 lint on save 체크, format on save 체크, settings.json 에서 "editor.codeActionsOnSave": { "source.fixAll.eslint": true } 추가
   # 또는 터미널에서 black [파일 이름] 치면 린트가 되어 맞춰 집니다.
   
   def hello():
       return "Hello World!"
   
   if __name__ == "__main__":  # pragma: no cover
   # # pragma: no cover가 있는 유닛은 린트 체크 제외 대상으로 지정됩니다.
       ret = hello()
       print(ret)

   
   
   • main_test.py

   # main.py의 내용을 test 하는 파일입니다. 
   import unittest
   
   from main import hello # 모듈 명과 불러올 함수
   
   class MainTest(unittest.TestCase):
       def test_hello(self): # 함수 등을 테스트할 함수 이름 지정 
           self.assertEqual(hello(), "Hello World!") # 해당 함수 이름과, return 내용 지정
   
   if __name__ == "__main__":  # pragma: no cover
       unittest.main()

   
   
   • README.md

     codeclimate login - quality - Open source - 해당 레포 - Repo Settings - Badges 에서 Maintainability Badge 와 Test Coverage Badge의 Markdown을 복붙해서 배지 코드를 적어놓습니다.

   #### CI Status 예시
   
   [![Maintainability](https://api.codeclimate.com/v1/badges/64f03b8b27952133bfd0/maintainability)](https://codeclimate.com/github/anisepy/stock_price_downfall_predict/maintainability)
   
   [![Test Coverage](https://api.codeclimate.com/v1/badges/64f03b8b27952133bfd0/test_coverage)](https://codeclimate.com/github/anisepy/stock_price_downfall_predict/test_coverage)
   
   ## How to run?
   
   $ python main.py
   
   
   ## How to run test code?
   
   $ python -m unittest discover -p "*_test.py"

9. test

   • F1 키 → test → python: 테스트구성 → unittest → .Root directory → *_test.py

10. 커밋

    git add .
    
    git commit -a -m “comment”
    
    git checkout -b [브랜치명] : 해당 브랜치를 생성 후 이동
    
    git push --set-upstream origin feature/unittest : 브랜치 없을때 나는 오류, 복붙해서 명령어 치면 브랜치 생성되면서 커밋

    커밋시 action에서 통과되지 않을 시 오류 확인 후 Re-run all jobs 실행

11. Coverage Report, Lint Code Base 모두 통과 시 브랜치 pull request

여기까지입니다. 참고하셔서 모두 깔끔한 레포 code 관리하실 수 있으시길 기원합니다.