Github Action 시, Submodule 접근 문제

들어가며

최근 프로젝트 진행하면서 프론트, 백엔드에서 공통적으로 쓰이는 타입을 어떻게 관리할 지 고민하였습니다.
고민 끝에 저희는 Submodule을 사용해 공통 타입을 관리하기로 결정하였습니다.

문제점

Github Action에서 git submodule update 명령어 실행 시 다음과 같은 에러가 발생하였습니다.

🧐 원인

• 저희는 Private repository에서 submodule을 관리하고 있었습니다. 따라서 아무런 설정을 해주지 않는다면, Github Action에서 해당 repo로 접근하지 못하여 에러가 발생하였습니다.

문제 해결

1. Github Action workflow 수정

	steps:
	 - uses: actions/checkout@v3
 	   with:
    	submodules: true
    	token: ${{ secrets.PAT_TOKEN }}

2. Generate the Personal Access Token (토큰 생성 시, repo checkbox)

3. 발급 한 토큰, github action을 돌리는 repo의 action secret에 등록