배포 관련 연습을 하기 위해 git에 레포지토리를 만들고 초기 설정을 할 일이 생겼는데 다음에 또 할 일이 생기면 참고하기 위해서 진행 과정에 대해 작성하려 한다.
첫 번째 방법
먼저 git에 repository를 만들었다.
간단히 Repository 이름을 설정하고 README 파일만 추가하고 만들었다.
다음으로 https://start.spring.io/ 해당 사이트에서 Dependencies에 spring web, spring data jpa, Thymeleaf, MySQL Driver를 추가 한 뒤 Generate를 눌러 파일을 다운로드 받았다.
- Group : 기업 도메인명
- Artifact : 빌드되어 나올 결과물
- Name : 프로젝트명 (일반적으로 Artifact와 동일하게 해준다.)
- Description : 설명
- Package name : 패키지 이름 (Group과 Artifact를 설정하면 자동으로 만들어준다.)
만든 리포지토리 화면으로 이동하여 코드 부분의 HTTPS 부분의 주소를 복제하고 터미널에서 사용할 폴더로 이동해 git clone {https 주소} 를 입력한다.
위 과정을 마치면 해당 폴더에 DevOps-Test라는 폴더가 생긴다.
DevOps-Test 폴더에 https://start.spring.io/ 에서 받은 폴더 안의 파일들을 옮기고 인텔리제이로 해당 폴더를 연다.
이후에 datasource 부분 설정하고 git에 올리지 않을 파일은 .gitignore에 작성하고, 올릴 파일들에 대해 commit하고 push하면 된다.
두 번째 방법
https://start.spring.io/ 에서 받은 파일을 이용하는 것은 동일하다.
또한 초기 레포지토리의 이름이 master인데 이를 main으로 변환해 주는 부분이 다르다.
- 레포지토리에 사용할 폴더로 이동한다.
- git init
- git branch -M main
- git remote add origin <레포지토리 주소>
- git push -u origin main
5번 이전에 첫번째 커밋을 하면된다.
git 초기설정 예시 이미지
아래는 지피티에게 물어본 내용이다
올려야 하는 최소파일
-
소스 코드: src/ 디렉토리 내의 Java 파일,
예를 들어 com.example.DevOpsTestApplication.java 같은 파일들은 필수로 올려야 합니다. -
설정 파일: build.gradle, settings.gradle, application.yml 같은 프로젝트 설정 파일들은 반드시 올려야 프로젝트를 다른 사람이 빌드하고 실행할 수 있습니다.
-
프로젝트 관련 설명: README.md 파일은 프로젝트에 대한 설명을 포함하므로 올리는 것이 좋습니다.
-
.gitignore: 깃에서 무시할 파일을 정의하는 .gitignore 파일은 꼭 포함되어야 합니다.
올리면 안되는 파일들
-
IDE 설정 파일: IntelliJ (.idea), NetBeans (nbbuild/, nbdist/), VSCode (.vscode) 등의 설정 파일은 개인적인 개발 환경에 따라 다르므로 깃허브에 올리지 않는 것이 좋습니다.
-
컴파일된 파일 및 빌드 출력물: out/, bin/ 폴더 등은 소스 코드가 아닌 결과물이므로 깃허브에 올리지 말아야 합니다.
-
로그 파일: 작업 중 생기는 .log 파일들도 추적할 필요가 없습니다.
-
민감한 정보가 포함된 파일: 데이터베이스 설정, API 키, 비밀번호 등 민감한 정보가 포함된 파일은 올리지 말아야 합니다. 예를 들어, application-db.yml 파일에 민감한 정보가 있다면 올리지 않는 것이 좋습니다.
올릴지 말지 선택할 수 있는 파일들
- 환경 변수 파일: 민감한 정보는 포함하지 않지만, 로컬에서 환경 변수를 설정하는 파일들이 있을 수 있습니다. 예를 들어, .env 파일은 환경마다 다르므로 올리지 않는 경우가 많습니다.
