CHAMPREP コードコマンド
champrep code CodeCHAMPREPは、ターミナルから以下の機能を利用できます:プロジェクトや ブランチ、一括クローン、マージリクエスト、イシュー、パイプラインおよびジョブログ、CI ランナー、リリースなどです。Codeは 通常のCLIサインインでユーザーとして動作するため、各 プロジェクトにおける役割、プラン、およびクォータが、Webアプリとまったく同じように適用されます。
開始する前に
Section titled “開始する前に”- インストールしてください。 CLI および ログイン で
champrep auth login. - ご利用のプランには「CodeCHAMPREP」が含まれている必要があります。含まれていない場合、コマンドは
not available to your account(終了コード1).
champrep auth loginchamprep code projects ls
プロジェクト、マージリクエスト、およびイシューの命名
Section titled “プロジェクト、マージリクエスト、およびイシューの命名”PROJECTはプロジェクトのフルパスです。例:acme/web、またはそのID。 パスを入力するのが最も簡単です。- マージリクエストとイシューには、プロジェクトごとに番号が割り当てられます。番号を指定してください:
12および!12「merge request 12」という名前のものと、34および#34名前 issue 34。 PIPELINE_IDおよびJOB_IDは、表示される番号です。pipelines lsおよびjobs ls.
プロジェクトとリポジトリ
Section titled “プロジェクトとリポジトリ”| コマンド | 目的 |
|---|---|
champrep code projects ls | 自分がメンバーとなっているプロジェクトを一覧表示します。 --search TEXT, --all (閲覧可能なパブリックおよび内部プロジェクトも含まれます)、 --limit N. |
champrep code projects show PROJECT | プロジェクト、そのデフォルトブランチ、およびクローン用アドレスを表示します。 |
champrep code projects create NAME | 個人のネームスペース内、またはグループ内でプロジェクトを作成します。 --namespace。また --path, --visibility private|internal|public, --description, --default-branch. |
champrep code repo clone-url PROJECT | HTTPS クローンアドレスを表示します(--ssh (SSHアドレスの場合は)。 |
champrep code clone PROJECT... | プロジェクトを --dest (デフォルト .)、それぞれ独自の名前空間の下で: DEST/<group>/<subgroup>/<project>. |
champrep code clone --group GROUP | グループ内のすべてのプロジェクトをクローンします; --include-subgroups すべてのサブグループを追加します。 |
champrep code clone --membership / --owned / --all | 自分がメンバーであるプロジェクト、自分がオーナーであるプロジェクト、または自分が閲覧できるプロジェクトをすべてクローンします。 |
champrep code branches ls PROJECT | ブランチと最後のコミットを一覧表示します。 --search, --limit. |
champrep code ssh-keys ls | CodeアカウントのSSHキーを一覧表示します。 |
code clone オプション:
--ssh、または--https(デフォルト)、プロトコルを選択します。--dry-run何が起こるかを一覧表示します。--parallel NN 個の git 操作を一度に実行します(デフォルトは 4、最大 16)。--archivedアーカイブされたプロジェクトも含まれます。--updateすでにクローン済みのプロジェクトは、スキップするのではなく、 フェッチおよびファストフォワードを行います。以下の条件を満たすクローンの場合、origin別のリポジトリである場合は、次のように報告されます。mismatch. デタッチされた HEAD またはアップストリームのないブランチは、次のように報告されます。no-upstream.--search TEXTに一致するプロジェクトのみを保持します。--max-projects N最大 N 個のプロジェクト(デフォルトは 1000)を処理します。これは 以下の--ownedフィルター。
概要を表示して終了します 1 いずれかのプロジェクトが失敗した場合、または実行が 中断された場合(Ctrl-C により、新しいクローンおよび実行中のクローンが停止します)。 --json it プロジェクトごとに1つのエントリを、その status.
バルククローンでは、プロンプトは表示されません。git は GIT_TERMINAL_PROMPT=0、および SSH は以下のように実行されます。 BatchMode=yes ただし、以下を設定した場合は除きます。 GIT_SSH_COMMAND または
core.sshCommand ご自身で。ただし https:// また、CHAMPREP Codeホスト上のSSHアドレスはクローンされ、gitは他のすべてのトランスポートが無効化された状態で実行されます。
git は独自に認証を行います。SSH キー、または git の認証情報ストアに保存された 個人用アクセストークンを使用します。いずれも Code Web アプリで一度設定すれば済みます。詳しくは
Gitの認証情報を設定する。はCLI 、リモートURLや .git/config.
マージリクエスト
Section titled “マージリクエスト”mr 以下の形式も受け付けます merge-requests.
| コマンド | 目的 |
|---|---|
champrep code mr ls PROJECT | マージリクエストを一覧表示します。 --state opened (デフォルト)、 merged, closed, locked または all; --mine; --search; --limit. |
champrep code mr show PROJECT IID | マージリクエスト、そのマージステータス、およびヘッドパイプラインを表示します。 |
champrep code mr create PROJECT | マージリクエストを開きます。以下が必要です。 --source, --target および --title;また --description, --draft, --remove-source-branch, --squash. |
champrep code mr merge PROJECT IID | 今すぐマージするか、または --auto パイプラインが成功した場合。また --squash, --remove-source-branch, --message, --sha. |
champrep code mr approve PROJECT IID | 承認します。 --sha 承認を、レビューしたコミットに紐付けます。 |
| コマンド | 目的 |
|---|---|
champrep code issues ls PROJECT | 課題を一覧表示します。 --state opened (デフォルト)、 closed または all; --labels a,b; --search; --mine (あなたに割り当てられたもの); --limit. |
champrep code issues show PROJECT IID | 課題を表示します。 |
champrep code issues create PROJECT | 課題を作成します。以下が必要です。 --title;また --description, --labels, --confidential, --due YYYY-MM-DD. |
champrep code issues close PROJECT IID | 課題をクローズします。 |
champrep code issues reopen PROJECT IID | クローズされた課題を再開します。 |
パイプラインとジョブ
Section titled “パイプラインとジョブ”pipelines 以下の形式も受け付けます pl.
| コマンド | 目的 |
|---|---|
champrep code pipelines ls PROJECT | パイプラインを一覧表示します(新しい順)。 --ref, --status, --limit. |
champrep code pipelines show PROJECT PIPELINE_ID | パイプラインと、その中のすべてのジョブを表示します。 |
champrep code pipelines run PROJECT --ref REF | ブランチまたはタグに対してパイプラインを実行します。 --var KEY=VALUE 変数を追加します(繰り返し実行可能)。 |
champrep code pipelines retry PROJECT PIPELINE_ID | 失敗およびキャンセルされたジョブを再実行します。 |
champrep code pipelines cancel PROJECT PIPELINE_ID | 実行中のパイプラインをキャンセルします。 |
champrep code pipelines wait PROJECT [PIPELINE_ID] | パイプラインの完了を待機します:指定されたもの、または --sha SHA (または --sha HEAD リポジトリ内(パイプラインが出現するのを待機します)、または最新のものを --ref BRANCH その時点(デフォルト:デフォルトブランチ)です。プッシュ後は、 --sha: --ref 前のコミットのパイプラインを引き続き見つけることができます。間隔を徐々に長くしながら(5秒から60秒まで)チェックを行います。進行状況と最終的なステータス行はstderrに出力され、 --json 完了したパイプラインを出力します。スケジュールされた(遅延)ジョブの場合、処理は待機状態となります。終了します。 0 成功した場合は、 1 失敗した場合、キャンセルまたはスキップされた場合、あるいは手動ジョブで停止された場合(--manual-ok を受け入れます)、そして 8 when --timeout (デフォルト 60m) がタイムアウトします。 |
champrep code jobs ls PROJECT | ジョブを、新しい順に、または特定のパイプラインのジョブを以下のように一覧表示します。 --pipeline ID. --status failed,running; --limit. |
champrep code jobs log PROJECT JOB_ID | ジョブのログを出力します。 --tail N は、ログの末尾から読み込んだ最後のN行を出力するため、どのようなサイズのログでも動作します。 --follow (-f) は、ジョブが終了するまで出力し続けます。「Job N finished」という終了行は stderr に出力されるため、stdout にはログのみが保持され、終了コードがジョブの結果となります: 0 成功した場合は、 1 失敗またはキャンセルされた場合。8 MiBを超えるログには --tail または --follow, これにより、直近の100行から処理が再開されます。 |
champrep code jobs play PROJECT JOB_ID | 手動ジョブを開始します。 --var KEY=VALUE ジョブ変数を渡します。 |
champrep code jobs retry PROJECT JOB_ID | 完了したジョブを再実行します。 |
runners 以下の形式も受け付けます runner.
| コマンド | 目的 |
|---|---|
champrep code runners ls | 管理しているプロジェクトとグループランナーを一覧表示してください。 --project PROJECT (プロジェクトで使用可能なランナー;メンテナー)、 --group GROUP (所有者)、 --all (インスタンス管理者)。フィルター: --status online|offline|stale|never_contacted, --paused / --active, --tag a,b, --type instance|group|project, --search, --limit. |
champrep code runners show RUNNER_ID | ステータス、オンライン状態、一時停止状態、タグ、最終連絡日時、マシン、および割り当てられたプロジェクトやグループを表示します。 |
champrep code runners update RUNNER_ID | --tags a,b タグリストを置き換えます; --add-tag / --remove-tag (繰り返し実行可能)タグを読み取り、リスト全体を書き戻すことで変更を行います。そのため、その間に誰かが加えた変更は上書きされてしまいます; --pause / --resume; --description. |
champrep code runners create | プロジェクトランナーを作成します(--project、メンテナー)またはグループランナー(--group(所有者)。また --description, --tags, --no-untagged, --protected, --locked, --paused。ランナーの認証トークンを表示します(ccrt_…) を標準出力に一度だけ表示し、ログには記録しません。常に --yes. エイリアス register. |
マシンを新しいランナーに接続するには、
champrep-code-runner register。 ランナー・トークンのリセットやインスタンス・ランナーの作成は、Webアプリ内で行われます。
| コマンド | 目的 |
|---|---|
champrep code releases ls PROJECT | リリースを、新しい順に一覧表示します。 --limit. |
リストはデフォルトで20行表示されます。表示行数を増やすには --limit (最大500件)まで増やすと、さらに多くのジョブが表示されます。行数がそれ以上ある場合はその旨 CLIが表示され、 --limit 500 その場合は、代わりに フィルタを絞り込むよう求められます。 jobs ls --pipeline ID --status S パイプラインの最初の 500 件のジョブを読み込んだ後、 ユーザー側でフィルタリングを行い、それ以上のジョブが存在する可能性がある場合はその旨を通知します。
タスクごとの具体的な手順や、スクリプトによるバリエーションについては、 一般的なタスク.
グループ全体(サブグループを含む)をクローンし、最新の状態に保つには:
champrep code clone --group acme --include-subgroups --dest ~/src --sshchamprep code clone --group acme --include-subgroups --dest ~/src --ssh --updateプロジェクトをクローンし、ご自身のブランチに対してマージリクエストを開いてください:
git clone "$(champrep code repo clone-url acme/web)"champrep code mr create acme/web --source feature/login --target main \ --title "Add login page" --remove-source-branch --yes未処理のマージリクエストを確認し、パイプラインが正常に通過したものをマージしてください:
champrep code mr ls acme/webchamprep code mr show acme/web 12champrep code mr merge acme/web 12 --auto --squash --yesパイプラインを実行し、完了を待ち、ジョブのログを確認するには:
champrep code pipelines run acme/web --ref main --var DEPLOY=staging --yeschamprep code pipelines wait acme/web --ref main && echo "main is green"champrep code pipelines ls acme/web --ref main --limit 5champrep code pipelines show acme/web 9921champrep code jobs log acme/web 4182 --follow失敗したジョブを検索し、1つ再試行してください:
champrep code jobs ls acme/web --status failedchamprep code jobs log acme/web 4180 --tail 50champrep code jobs retry acme/web 4180 --yes課題の追跡:
champrep code issues ls acme/web --labels bug --search loginchamprep code issues create acme/web --title "Login fails on Safari" --labels bug,webchamprep code issues close acme/web 34 --yes
確認とスクリプト
Section titled “確認とスクリプト”重要な変更を行うコマンドは、実行前に確認を求めます: mr create
(マージリクエストを開くとパイプラインが開始される場合があります)、 mr merge, mr approve,
issues close および reopen, runners update、およびすべてのパイプラインとジョブの アクション(run, retry, cancel, play)、これらはCI分を使用します。
runners create には常に --yes、これもターミナル上では、認証情報が表示されるため、 が必要です。 clone はディスク上のデータのみを変更し、確認を求めません。ターミナル上では、次のように回答してください。 y。 スクリプト内では、を指定してください。 --yes (-y)。ターミナル以外で、かつ --yes この コマンドは処理を拒否し、何も変更しません。
プロジェクトやイシューの作成時には確認は求められません。作成、マージ、パイプラインの実行、 再試行、キャンセル、およびジョブの実行と再試行には冪等性キーが付与されるため、 ネットワークエラー後の自動再試行CLIによって、同じ処理が二度行われることはありません。
は、プロジェクト、マージリクエスト、イシュー、パイプライン、またはジョブの引数が 以下の条件を満たす場合、拒否CLIします: . または .. 何かを送信する前に、パスセグメントを確認します。
追加 --json 返されたコードを出力するには:リストは項目のJSON配列を出力し、
pipelines show 出力します { "pipeline": …, "jobs": [ … ] }.
champrep code mr ls acme/web --json | jq -r '.[] | "\(.iid) \(.title)"'
発生する可能性のあるエラー
Section titled “発生する可能性のあるエラー”| メッセージ | 対処方法 |
|---|---|
needs your web session … (SESSION_REQUIRED) | マージまたは承認を行うには、 保護されたブランチ この決定は、CodeCHAMPREP Webアプリにログインしているご本人様のみが行うことができます。ブラウザでマージリクエストを開き、そこでマージまたは承認を行ってください。保護されていないブランチは、から操作できますCLI。 |
not allowed for your role … (MERGE_NOT_ALLOWED), (PROJECT_ARCHIVED) | プロジェクトにおけるあなたの役割ではその操作が許可されていないか、プロジェクトがアーカイブ(読み取り専用)されています。メンテナまたはオーナーにお問い合わせください。 |
not available to your account … | ご利用のプランまたは組織のポリシーには、CHAMPREPCode またはこの機能が含まれていません。詳しくは プラン または、管理者にお問い合わせください。 |
quota exceeded …, payment required … | ご利用のプランの容量またはCI分が使い切られています。「請求CHAMPREP」で容量を追加してから、コマンドを再度実行してください。 |
not found … | プロジェクト、マージリクエスト、イシュー、またはパイプラインが存在しないか、表示できません。 |
http 409 … (SHA_MISMATCH) | マージリクエストは、前回確認された時点から移動しています。ご確認ください。 mr show 再度お試しください。 |
終了コードは以下の コマンドリファレンス:上記の すべての拒否は終了します 1、以下を含みます: --json 実行されます; 3 は、再度サインインする必要があることを 意味します。 5 ゲートウェイのレート制限、 6 ネットワーク障害が発生し、 7 サービス 再試行しても解消されなかった障害。 pipelines wait exits 1 パイプラインが 成功しなかった場合は、 8 その場合、 --timeout 時間が切れてしまいました; jobs log --follow exits 1 ジョブが失敗またはキャンセルされた場合は、を使用してください。waitとretryは、 サービスエラー、レート制限、ネットワーク障害に対してそれぞれ自動的に再試行を行い、 8回連続で再試行に失敗した場合は処理を中止します。