CLIの使い方
この使用方法に関するマニュアルでは、cliのインストール手順を終えていることを前提としています。
簡単な注意: 以下では、単純にするために<コード>all-contributorsを使用しますが、もし何か問題があれば、all-contributors<コード>の方を試してみてください 😺
コマンド
all-contributors init
all-contributors-cliの使い始めるときに実行する。 このコマンドは、いくつかの質問を行い、all-contributorsに対してプロジェクトを設定します。 この設定では、.all-contributorsrc設定ファイルを作成し、指定したファイル (たいていはREADME.md) にコントリビューターテーブルを作成します。
all-contributors add
プロジェクトに新しいコントリビューターを追加したり、コントリビュートした方法を追加するには、addを使用します。 コントリビューターが設定ファイルに加えられると、生成コマンドを使用したときと同じように、コントリビューターファイルを更新します。
# <contribution>タイプのコントリビューションを行った新しいコントリビューター<username>を追加する
all-contributors add <username> <contribution>
# 例:
all-contributors add jfmengels code,doc
ここでは、usernameGitHubやGitlabのユーザー名であり、contributionはコントリビューションの,-区切りのリストです。 有効なcontributionタイプのリストについてはEmoji キー(コントリビューションタイプのリファレンス)を参照してください。
GitLabユーザー: GitLabユーザーの追加要件を参照してください。
all-contributors check
checkを使用して、GitHub上のコントリビューターと.all-contributorsrcファイルにクレジットされたコントリビューターを比較し、クレジットが適切に与えられているかどうかを確認します。
GitHub API制限のためこのコマンドはコントリビューターが500よりも少ないプロジェクトにおいてのみ機能します (GitHubユーザー下部で述べるように、
PRIVATE_TOKENを設定しない限り)。
all-contributors generate
generateを使用して、 .all-contributorsrcファイルからcontributorsリストを読み込み、 filesキーで指定されたファイルのコントリビューターテーブルを更新します。
このコマンドは、テーブルを更新するために、指定ファイル内の以下のタグを検知できる必要があることに注意してください:
<!-- 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という名前の環境変数を設定する必要があります。
プライベートトークンは、GitHub APIの認証するためのパーソナルアクセストークンです。
GitLabユーザー
gitlabインスタンスを自分でホストしている場合、いくつかのコマンドを使用する前にPRIVATE_TOKENという名前の環境変数を設定する必要があることに注意してください。
プライベートトークンは、GitLab APIの認証するためのパーソナルアクセストークンです。
# Linux上でprivate tokenを設定する
export PRIVATE_TOKEN=your_private_token
# Windows上でprivate tokenを設定する
set PRIVATE_TOKEN=your_private_token