Branch "한국어" is not allowed to deploy to github-pages due to environment protection rules.

❓ 문제

Swagger UI를 github page로 배포하려 하였으나 배포가 되지 않았습니다.

⚙️ 상황

저희 팀은 이슈를 만들고 이슈에 대한 브랜치를 자동으로 생성해주는 GitHub의 기능을 사용하고 있었습니다.

브랜치의 이름은 이슈 이름과 번호의 조합이었고 이슈 이름은 한국어로 작성했습니다.

 

Swagger UI는 다음 레포지토리의 방법을 참고하여 사용했습니다.

GitHub - peter-evans/swagger-github-pages: How to host Swagger API documentation with GitHub Pages

🐞 원인

문제는 한국어 브랜치 이름이었습니다.

 

github action의 실패 로그는 다음과 같았습니다.

해석해보면 해당 브랜치로 배포를 할 수 있는 protection rule이 없다는 뜻입니다.

 

하지만 저는 다음과 같이 설정했습니다.

Settings > Code and automation > Pages

Settings > Code and automation > Environments > github-pages > Deployment branches

바로 위의 이미지를 잘 보시면 다음과 같은 문장이 있다는 것을 눈치채실 수 있습니다.

Currently applies to 0 branches

즉, 해당 설정이 적용되지 않았다는 의미입니다. 

 

정확한 원인은 모르겠지만 GitHub에서 한국어 패턴으로 브랜치를 찾지 못하는 것 같아 브랜치 이름을 영어로 바꾸어 해결했습니다.