GitHub Actions을 활용한 블로그 글 문법 검사 자동화 방법

가나톡ganaTOK
가나톡ganaTOK

GitHub Actions을 활용한 블로그 글 문법 검사 자동화 방법

GitHub Actions을 사용하면 블로그 글의 문법과 스타일 검사를 자동화하여 품질 높은 콘텐츠를 유지할 수 있습니다. 자동 문법 검사는 Pull Request(PR) 시점에 실행되며, 문법 오류와 스타일 문제를 자동으로 감지해 팀이 빠르게 수정할 수 있도록 합니다.

아래는 GitHub Actions을 통한 블로그 글 문법 검사 자동화 방법입니다.

1. 문법 검사 도구 설정

1) Vale 도구 설치

Vale는 오픈소스 문법 및 스타일 검사 도구로, 다양한 텍스트 파일을 분석할 수 있습니다.

  • 로컬 개발 환경에 Vale 설치:

    bash
    brew install vale   # macOS (Homebrew 사용)
sudo apt-get install vale  # Ubuntu

  • 설치 확인:

    bash
    vale --version

2) Vale 스타일 설정 파일 생성

  • 프로젝트 루트에 .vale.ini 파일을 생성해 Vale의 규칙을 정의합니다:

    ini
    StylesPath = .github/styles
MinAlertLevel = suggestion

[*.md]  # Markdown 파일만 검사
BasedOnStyles = Vale, Google  # Google 스타일 준수

  • 스타일 디렉터리 생성 및 규칙 추가:

    bash
    mkdir -p .github/styles/Vale

    예: Google 스타일 규칙을 정의한 YAML 파일:

    yaml
    extends: existence
message: "Avoid passive voice"
level: warning
scope: text
match: '\b(is|was|were|been|being)\b'

2. GitHub Actions 설정

1) Actions 워크플로우 파일 생성

  • 프로젝트의 .github/workflows 폴더에 vale.yml 파일을 생성합니다:
    yaml
    name: Vale Grammar Check

on:
  pull_request:  # PR 생성 또는 업데이트 시 트리거

jobs:
  grammar_check:
    runs-on: ubuntu-latest

    steps:
    - name: Check out repository
      uses: actions/checkout@v3

    - name: Install Vale
      run: sudo apt-get install -y vale

    - name: Run Vale on Markdown files
      run: vale --output=stdout . || exit 0

2) 워크플로우 파일의 주요 내용

  • on: pull_request: PR 생성이나 업데이트 시 문법 검사 실행.
  • actions/checkout@v3: 저장소를 체크아웃해 로컬 작업을 수행합니다.
  • vale --output=stdout: Markdown 파일을 검사하고 결과를 콘솔에 출력합니다.

3. PR에서 문법 검사 결과 확인

1) Pull Request 생성 및 문법 검사 실행

  1. 팀원이 새로운 블로그 글 초안을 작성해 브랜치에 커밋하고 PR을 생성합니다:

    bash
    git checkout -b feature/blog-draft
git add .
git commit -m "Add blog draft"
git push origin feature/blog-draft

  2. GitHub Actions가 자동으로 Vale 문법 검사를 실행합니다.

2) 검사 결과 피드백 확인

  • PR 탭에서 문법 검사 결과를 확인할 수 있습니다.
  • 오류가 발견되면 경고 메시지가 표시되고, 팀원은 즉시 수정할 수 있습니다.

4. 문법 오류 수정 및 재검사

  1. 팀원이 PR에서 경고 메시지를 확인한 후, 로컬에서 수정합니다:

    bash
    git add .
git commit -m "Fix passive voice issue"
git push origin feature/blog-draft

  2. PR 업데이트 시 GitHub Actions가 자동으로 재실행되어 오류가 해결되었는지 검사합니다.

5. 자동화된 워크플로우의 장점

  • 일관된 스타일 유지: 팀원들이 동일한 문법 규칙을 따를 수 있습니다.
  • 자동화된 피드백 제공: 문법 오류를 사전에 방지하여 고품질 콘텐츠를 보장합니다.
  • 협업 효율성 향상: PR 과정에서 즉각적인 피드백을 제공하여 수정 작업을 신속하게 완료합니다.

6. 결론

GitHub Actions와 Vale 도구를 활용하면 블로그 글의 문법과 스타일을 자동으로 검사하고 PR 단계에서 즉시 피드백을 제공할 수 있습니다. 이 자동화된 워크플로우는 팀원 간의 협업을 최적화하고, 품질 높은 콘텐츠를 지속적으로 생산하는 데 큰 도움을 줍니다.

Related Posts

로드 중…