CLI 설명서
Cli 설치를 읽지 않으셨으면 먼저 읽어 주세요.
참고: 아래 설명은 문서를 간결하게 보이기 위해 yarn을 빼고 all-contributors만 보여 줍니다. CLI를 사용 하실 때 yarn all-contributors로 실행 해 주세요.
코멘드들
all-contributors init
처음으로 all-contributors-cli를 사용할 때 이것을 실행하십시오. 이 코맨드는 몇 가지 질문을 하고 All Contributors 프로젝트를 설정합니다. 이 설정 안에는.all-contributorsrc 구성 파일을 작성하고 지정한 파일 (보통 README.md)에 기여자 목록을 작성하는 작업이 포함됩니다.
all-contributors add
add를 사용하여 새 기여자를 프로젝트에 추가하거나 도움을 준 방법을 추가하십시오. 이 파일은 구성 파일에 추가되고 기여자 파일은 all-contributors generate를 사용한 것처럼 업데이트됩니다.
# Add new contributor <username>, who made a contribution of type <contribution>
all-contributors add <username> <contribution>
# Example:
all-contributors add jfmengels code,doc
여기서 username은 사용자의 GitHub 또는 Gitlab 사용자 이름이고 contribution은 "," (콤마) 로 분리 된 기여자 목록입니다. 유효한 contribution 유형의 목록을 보려면 Emoji Key ✨ (및 기여 유형)를 참조하십시오.
GitLab을 사용하시는 분은 GitLab 사용자를 위한 추가 요구 사항을 참조하십시오.
all-contributors check
check코맨드로 GitHub의 기여자와 .all-contributorsrc 파일의 비교하여 기여자가 승인되었는지 확인하실 수 있습니다.
GitHub API 제한으로 인해 이 코맨드는 기여자가 500명 미만인 프로젝트에서만 작동합니다 (GitHub 사용자에서 언급한
PRIVATE_TOKEN을 설정하면 제한이 해제됩니다).
all-contributors generate
generate를 사용하여 .all-contributorsrc에서 기여자 목록을 읽고 파일 키로 지정된 기여자 목록을 갱신하십시오.
코맨드는 목록을 갱신하기 위해 해당 파일에서 다음 태그를 찾을 수 있어야 합니다:
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
Also note that it needs to find the following tags in order to update the badge:
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<!-- ALL-CONTRIBUTORS-BADGE:END -->
GitHub 사용자
GitHub API rate limit exceeded for xxx라는 오류 메시지가 뜰 경우에는 GitHub rate limit를 우회하기 위해 PRIVATE_TOKEN 환경 변수를 설정해야 할 수도 있습니다.
Private Token은 GitHub API로 인증하는 개인 액세스 토큰입니다.
GitLab 사용자
자체 호스트 된 gitlab을 사용하는 경우, 일부 코맨드는 먼저 PRIVATE_TOKEN이라는 환경 변수를 설정해야 합니다.
Private Token은 GitLab API로 인증하는 개인 액세스 토큰입니다.
# Linux에서 개인 토큰 설정
export PRIVATE_TOKEN=your_private_token
# Windows에서 개인 토큰 설정
set PRIVATE_TOKEN=your_private_token