[Github action] 깃헙액션으로 PR컨벤션 체크하기

eunji·2022년 11월 7일

깃헙액션을 이용하여 PR 타이틀 포맷을 자동으로 체크해줄만한게 있나 깃헙 마켓플레이스에서 찾아보다가 괜찮은 템플릿이 있길래 사용해보았다.

설정

우선 ./github/workflows 폴더에 lint_pr.yml이라는 파일을 생성하였다.
그리고 description에 쓰여있는대로 뼈대를 작성하였고 내 입맛에 맞게 configuration을 추가하였다.

name: 'Lint PR'

on:
  pull_request:
    types:
      - opened
      - edited
    branches:
      - stage

jobs:
  main:
    name: Validate PR title
    runs-on: ubuntu-latest
    steps:
      - uses: amannn/action-semantic-pull-request@v5
        with:
          types: |
            fix
            feat
            docs
            style
            refactor
            typo
            chore
            ci
          subjectPattern: ^[ㄱ-ㅎ가-힣a-zA-Z0-9 ]{5,50}$

        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

on:
  pull_request:
    types:
      - opened
      - edited
    branches:
      - stage

stage branch로 pull request가 발생할 때 workflow를 실행한다.
types

opened: PR이 오픈되었을 때
edited: PR이 수정되었을 때

더 자세한 설정은 여기

steps:
      - uses: amannn/action-semantic-pull-request@v5
        with:
          types: |
            fix
            feat
            docs
            style
            refactor
            typo
            chore
            ci
          subjectPattern: ^[ㄱ-ㅎ가-힣a-zA-Z0-9 ]{5,50}$

types : 커밋의 성격을 나타내는 type들을 지정한다.
subjectPattern: 제목부분에 대한 제한조건을 정규식을 통해 나타낸다.
여기서는 한글, 영어(대,소문자), 숫자로 이루어져있고 글자는 최소 5글자에서 최대 50글자로 이루어져야한다는 조건의 정규식을 만들었다.