콘텐츠로 건너뛰기
Lunaria

GitHub Action

룬아리아의 GitHub 액션은 머지 후 생성되는 번역 상태에 대한 변경 사항의 영향을 요약한 댓글을 풀 리퀘스트에 남깁니다. 이는 잠재적인 문제점과 룬아리아 작동 방식에 대한 통찰을 포함합니다.

사전 요구 사항

  • Node.js - v20.0.0 이상.
  • @lunariajs/core - v0.1.0 이상.

액션 설정

프로젝트 내 .github/workflows/lunaria.yml 경로에 다음 내용으로 새 파일을 생성하세요. 사용하는 패키지 매니저에 따라 다릅니다:

name: 룬아리아


on:
  # 대상 `main` 브랜치에서 풀 리퀘스트가 열리거나 동기화될 때마다 워크플로우를 트리거합니다
  # 다른 브랜치 이름을 사용하고 계신다면 `main`을 자신의 브랜치 이름으로 교체하세요
  pull_request_target:
    types: [opened, synchronize]
    branches: [main]


# 이 작업이 저장소를 클론하고 풀 리퀘스트에 댓글을 달 수 있도록 허용합니다
permissions:
  contents: read
  pull-requests: write


jobs:
  lunaria-overview:
    name: 룬아리아 개요 생성
    runs-on: ubuntu-latest


    steps:
      - name: 체크아웃
        uses: actions/checkout@v4
        with:
          # 룬아리아가 올바르게 작동하기 위해 필요합니다
          # 액션이 전체 git 기록을 클론하도록 합니다
          fetch-depth: 0


      - name: Node 설정
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: npm


      - run: npm install


      - name: 룬아리아 개요 생성
        uses: yanthomasdev/[email protected]

모든 설정이 제대로 완료되면, 이제 룬아리아가 추적하는 파일이 포함된 새 또는 업데이트된 풀 리퀘스트마다 해당 액션이 댓글을 남길 것입니다 (그러지 않는 경우 댓글을 받지 않습니다).

모노레포에 대한 추가 단계

기본적으로 액션은 저장소의 기본 디렉터리에서 @lunariajs/core 패키지를 찾습니다.

모노레포를 사용하고 있고 패키지가 루트 package.json 파일에 설치되지 않은 경우, working-directory를 올바른 경로로 설정해야 합니다.

이 예제에서는 @lunariajs/core 패키지가 docs/package.json 파일에 설치되었다고 가정하며, 따라서 working-directory는 docs로 설정되어야 합니다:

- name: 룬아리아 개요 생성
  uses: yanthomasdev/[email protected]
  with:
    working-directory: docs

개인 저장소에 대한 추가 단계

기본적으로 액션은 권한 부족으로 인해 개인 저장소에서는 실행되지 않습니다. 이를 해결하려면 몇 가지 추가 단계를 따르면 됩니다:

  1. GitHub에서 새로운 개인 액세스 토큰(PAT)을 생성하고, 저장소의 액션 시크릿에 추가합니다.

  2. .github/workflows/lunaria.yml 워크플로우 파일의 체크아웃 및 룬아리아 단계에 해당 시크릿 이름으로 token 입력을 추가합니다:

    - name: 체크아웃
        uses: actions/checkout@v4
        with:
          # 룬아리아가 올바르게 작동하기 위해 필요합니다
          # 액션이 전체 git 기록을 클론하도록 합니다
          fetch-depth: 0
          token: ${{ secrets.PAT }}
    - name: 룬아리아 개요 생성
      uses: yanthomasdev/[email protected]
      with:
        token: ${{ secrets.PAT }}

참조

입력값

  • token - 선택사항: 액션을 실행하기 위한 GitHub 개인 액세스 토큰입니다.

    - name: 룬아리아 개요 생성
      uses: yanthomasdev/[email protected]
      with:
        token: ${{ secrets.PAT }}

  • working-directory - 선택사항: 액션이 실행될 원하는 작업 디렉터리입니다. @lunariajs/core가 설치된 하위 디렉터리로 설정해야 합니다.

    - name: 룬아리아 개요 생성
      uses: yanthomasdev/[email protected]
      with:
        working-directory: docs