린팅 및 단위 테스트
GitHub Actions를 사용하여 이벤트에 의해 트리거되는 작업을 자동화할 수 있습니다. 끌어오기 요청을 만들 때 코드 품질 검사를 트리거하려면 다음을 수행해야 합니다.
- Linter 및 단위 테스트를 사용하여 코드를 검증합니다.
- 끌어오기 요청과 코드 검사를 통합합니다.
코드 확인
코드에서 수행할 두 가지 일반적인 검사 유형에는 Linter 및 단위 테스트가 있습니다.
Linter를 사용하여 코드가 조직에서 설정한 품질 지침을 준수하는지 확인할 수 있습니다. 예를 들어, Flake8을 사용하여 코드를 린팅하기 위해 코드가 준수해야 하는 규칙을 포함하는 .flake8 구성 파일을 만듭니다.
코드가 예상대로 작동하는지 확인하려면 단위 테스트를 만들 수 있습니다. 코드의 특정 부분을 쉽게 테스트하려면 스크립트에 함수가 포함되어야 합니다. 테스트 파일을 만들어 스크립트에서 함수를 테스트할 수 있습니다. Python 코드를 테스트하는 데 널리 사용되는 도구는 Pytest입니다.
팁
Pytest를 사용하여 단위 테스트를 실행하는 방법에 대해 자세히 알아봅니다.
GitHub Actions를 사용하여 코드를 확인하려면 다음을 수행해야 합니다.
- 도구(Flake8 또는 Pytest)를 설치합니다.
- 확인해야 하는 리포지토리 내의 폴더를 지정하여 테스트를 실행합니다.
팁
코드를 GitHub Actions를 사용하여 자동으로 확인하거나 Visual Studio Code에서 수동으로 확인할 수 있습니다. 로컬에서 코드를 확인하는 방법에 대해 자세히 알아봅니다.
끌어오기 요청과 코드 검사를 통합합니다.
끌어오기 요청을 만들 때 GitHub Actions 워크플로를 트리거하려면 on: pull_request을(를) 사용하면 됩니다.
모든 품질 검사가 통과된 경우에만 끌어오기 요청이 병합될 수 있는지 확인하려고 합니다.
코드 검사를 메인 브랜치를 대상으로 하는 풀 요청과 통합하려면 다음을 수행해야 합니다.
- 리포지토리 내의 설정 탭으로 이동합니다.
- 브랜치를 선택합니다.
- 메인 브랜치의 브랜치 보호 규칙에 따라 병합 전에 상태 검사가 통과되도록 요구하십시오.

여기서 린터와 단위 테스트를 검색하고 선택하여 필요에 따라 설정할 수 있습니다. 그런 다음 끌어오기 요청을 만들 때마다 GitHub Actions가 트리거되며 워크플로가 성공적으로 통과될 때만 끌어오기 요청을 병합할 수 있습니다.
참고
끌어오기 요청을 병합하기 전에 필요한 코드 검사를 구성하려면 작업에 GitHub Actions 워크플로의 이름이 있어야 합니다. 그런 다음 작업 이름을 검색하여 검사를 찾을 수 있습니다.