コンテンツにスキップ
Documentation

Code、Runner Farm、およびQAにおける一般的なタスク

このページは、簡単な手順集です。それぞれが、 コピーして使えるコマンドを用いて、1つのタスクを解決します。スクリプトが役立つ場合は、 --json | jq variant。 各コマンドのフラグについては、リファレンスページをご参照ください: CHAMPREP コード, Runner Farm および CHAMPREP QA.

例では、 acme はグループであり、 acme/web はプロジェクトであり、 code.champrep.com は CodeCHAMPREP です。

ログインしてアカウントを選択してください

Section titled “ログインしてアカウントを選択してください”
Terminal window
champrep auth login # opens the browser to approve the sign-in
champrep auth whoami # who the CLI acts as
champrep auth list # stored sign-ins, across environments
champrep auth switch PROFILE # make another stored sign-in the active one
champrep --env test code projects ls # one command against the test environment

CHAMPREP Codeには、ワークスペースを切り替える機能はありません。プロジェクトはグループ または個人のネームスペースに属しており、そのプロジェクト内での役割によって、実行可能な操作が決まります。

ランナーファームとQAは、ワークスペース(個人のアカウント、 組織、またはチーム)内で動作します。使用可能なワークスペースをリストアップし、次に KEY コラム の rf accounts ls (personal, organization:<id> または team:<id>) を使用して --workspace:

Terminal window
champrep rf accounts ls # KEY, workspace, your role, whether a farm account exists
champrep org ls # the same organizations and teams (ACCOUNT column)
champrep rf pools ls --workspace organization:65f0c0ffee0000000000abcd
champrep qa repos ls --workspace team:65f0c0ffee0000000000beef

champrep org use NAME は、次のような組織コマンドのデフォルトを設定します。 business members。Runner Farm と QA ではこれを無視します。渡す --workspace に クローンするか、Web アプリと同様にサービスにワークスペースを選ばせてください。

プロジェクトとそのクローンアドレスを探す

Section titled “プロジェクトとそのクローンアドレスを探す”
Terminal window
champrep code projects ls --search web
champrep code projects show acme/web # default branch, HTTPS and SSH addresses
champrep code repo clone-url acme/web # HTTPS address
champrep code repo clone-url acme/web --ssh # SSH address
git clone "$(champrep code repo clone-url acme/web --ssh)"

スクリプトのバリエーション:

Terminal window
champrep code projects ls --limit 500 --json | jq -r '.[].path_with_namespace'
champrep code projects show acme/web --json | jq -r .ssh_url_to_repo

gitは、経由せずCLI、CodeCHAMPREPと直接通信するため、独自の 認証情報が必要です。CodeCHAMPREPは、gitのパスワードとしてあなたのログインCLI情報を認めません。 個人用アクセストークンの作成やSSH鍵の追加は認証情報の変更にあたるため、 ログイン済みのWebセッションが必要です。ブラウザで一度だけ行ってください。

SSH(推奨)。 どのプロジェクトでも機能し、 平文で保存されることはありません。

  1. を開きます https://code.champrep.com/-/settings/ssh_keys.
  2. 公開鍵を貼り付けてください。例えば、 ~/.ssh/id_ed25519.pub.
  3. 鍵と接続を確認してください:
Terminal window
champrep code ssh-keys ls
git ls-remote git@code.champrep.com:acme/web.git HEAD

個人用アクセストークンを使用した HTTPS。

  1. を開きます https://code.champrep.com/-/settings/tokens.
  2. スコープを指定してトークンを作成してください read_repository、または write_repository プッシュする場合は、 有効期限を設定してください。
  3. gitの認証情報ストアを使用して、トークンをシステムのキーチェーンに保存するように設定します:
Terminal window
# macOS
git config --global credential.https://code.champrep.com.helper osxkeychain
# Windows (Git Credential Manager)
git config --global credential.https://code.champrep.com.helper manager
# Linux with libsecret (needs git-credential-libsecret, see below)
git config --global credential.https://code.champrep.com.helper libsecret

Linux では、 libsecret このヘルパーは、 git-credential-libsecret プログラムがインストールされていることを確認してください。多くのディストリビューションでは、git と一緒にインストールされません。 ディストリビューションのパッケージからインストールするか、git のソースからビルドしてください。 contrib/credential/libsecret フォルダに保存されます。以下で確認してください。 command -v git-credential-libsecret。キーリングがない場合は、 store ヘルパーは、トークンを ~/.git-credentials 平文で保存しないでください。代わりに cache --timeout=3600 代わりに、トークンをメモリ内のみ保持するツールを使用するか、SSHをご利用ください。

次に、1つのプロジェクトを手動でクローンします。gitはユーザー名(任意の値で構いません) とパスワード(トークンを貼り付けてください)を求め、資格情報ストアがそれらを保存します:

Terminal window
git clone https://code.champrep.com/acme/web.git

それ以降は、git と champrep code clone 保存されたトークンを使用してください。 次のようなリモートURLにトークンを含めないでください: https://user:TOKEN@…: git はその URL を .git/config、そのファイルやシェル履歴を読み取った人は誰でも それを利用できてしまいます。 champrep code clone は、認証情報を含むクローンアドレスを拒否します。

すべてのプロジェクトをクローンするすべてのプロジェクトをクローンする

Section titled “すべてのプロジェクトをクローンするすべてのプロジェクトをクローンする”

直接またはグループを通じてメンバーとなっているすべてのプロジェクトを、以下の場所にクローンしてください。 ~/src。各プロジェクトはそれぞれのネームスペース下に配置されます。例えば、 ~/src/acme/platform/api.

Terminal window
champrep code clone --membership --dest ~/src --ssh

その他の選択肢:

Terminal window
champrep code clone --owned --dest ~/src --ssh # projects where your role is Owner
champrep code clone --all --dest ~/src --ssh # also public and internal projects you can see
champrep code clone acme/web acme/api --dest ~/src # just these projects

まずは計画をご確認ください。ドライランでは、何も変更を加えることなく、 各プロジェクトと実行結果が一覧表示されます:

Terminal window
champrep code clone --membership --dest ~/src --dry-run

1つのグループとそのサブグループをクローンします

Section titled “1つのグループとそのサブグループをクローンします”
Terminal window
champrep code clone --group acme --dest ~/src --ssh # the group's own projects
champrep code clone --group acme --include-subgroups --dest ~/src --ssh # and every subgroup
champrep code clone --group acme --include-subgroups --archived --dest ~/src --ssh # archived projects too

--parallel N は、一度に実行されるクローンの数を設定します(デフォルトは4、最大16)。 アーカイブされたプロジェクトは、以下を追加しない限り除外されます --archived. --search TEXT は、名前またはパスにテキストが含まれるプロジェクトのみを保持します。

ローカルミラーを最新の状態に保ってください

Section titled “ローカルミラーを最新の状態に保ってください”

以下の設定で、同じコマンドを再度実行してください。 --update。これにより、新しいプロジェクトがクローンされ、 既存のプロジェクトが更新されます:

Terminal window
champrep code clone --group acme --include-subgroups --dest ~/src --ssh --update

既存のクローンごとに、 --update まず、その origin は、 HTTPS または SSH アドレスによるプロジェクトです。その パスにある別のリポジトリのクローンは、 mismatch (失敗)となり、そのまま放置されます。その後、実行されます git fetch --prune および現在のブランチのファストフォワードのみのマージが行われます。 ローカルの作業内容は上書きされることはありません:

  • 分岐したブランチは失敗として報告されますので、ご自身でマージまたはリベースを行ってください 。
  • デタッチド HEAD やアップストリームのないブランチは取得されるだけで、 次のように報告されます no-upstream.

設定がない場合 --update、既存のクローンはスキップされます。

コマンドは概要を表示して終了します 1 プロジェクトのいずれかが失敗した場合は、 スケジュールされたジョブによって通知が届くようになっています:

Terminal window
# crontab: refresh the mirror every night at 02:00
0 2 * * * champrep code clone --group acme --include-subgroups --dest "$HOME/src" --ssh --update >>"$HOME/src/.mirror.log" 2>&1

スクリプト版では、失敗した箇所を以下のように一覧表示します:

Terminal window
champrep code clone --membership --dest ~/src --ssh --update --json \
| jq -r '.[] | select(.status == "failed") | "\(.project): \(.error)"'

JSONステータスは以下の通りです。 cloned, updated, up_to_date, no_upstream, skipped, failed (with "reason": "mismatch" (別の リポジトリをクローンする場合は)、 interrupted および not_started Ctrl-C を入力した後、および、 --dry-run, would_clone, would_update および would_skip.

champrep code clone 複数のクローンが同時に実行されるため、プロンプトは表示されません。 git は以下の設定で実行されます。 GIT_TERMINAL_PROMPT=0。SSHは BatchMode=yesそのため、 ご自身で設定しない限り、パスワード、パスフレーズ、またはホストキーに関する確認は行われません。 GIT_SSH_COMMAND または core.sshCommand。SSHによる一括クローンを行う前に、次の 2つの手順を行ってください:

  1. 鍵を読み込んでください( )。 ssh-agent (ssh-add).
  2. 手動で一度接続し、ホストキーを受け入れてください(git ls-remote git@code.champrep.com:acme/web.git HEAD).

認証情報を必要とするプロジェクトでは、git は失敗せず、 could not read Username HTTPS経由または Permission denied (publickey) SSH経由で 実行されます。上記の認証情報を設定し、コマンドを再度実行してください。

Ctrl-Cを押すと、処理を正常に停止できます。新しいクローンは開始されず、実行中のクローンは 停止され(gitは途中まで完了したクローンを削除します)、サマリーに実行された内容が 表示されます。コマンドを再度実行すると処理が再開され、完了済みのクローンはスキップされます。

のみ https:// また、CodeCHAMPREPホスト上のSSHアドレスがクローンされ、 gitは他のすべてのトランスポートが無効化された状態で実行されます。

パイプラインの一覧表示と、ブランチ上の最新のパイプラインの確認

Section titled “パイプラインの一覧表示と、ブランチ上の最新のパイプラインの確認”
Terminal window
champrep code pipelines ls acme/web --limit 10
champrep code pipelines ls acme/web --ref main --limit 1
champrep code pipelines ls acme/web --status failed

スクリプト版:最新のパイプラインのステータスを main:

Terminal window
champrep code pipelines ls acme/web --ref main --limit 1 --json | jq -r '.[0] | "\(.id) \(.status)"'

pipelines wait パイプラインが完了するまで待機し、その終了コードが 結果となります: 0 成功; 1 手動ジョブで失敗、キャンセル、スキップ、または停止した 場合; 8 実行中のままの場合 --timeout (デフォルト 60m) が尽きました。

プッシュ後は、プッシュしたコミットのパイプラインが完了するまでお待ちください:

Terminal window
git push
champrep code pipelines wait acme/web --sha "$(git rev-parse HEAD)" && ./deploy.sh

--sha Codeが当該コミットのパイプラインを作成するのを待ち、その後、 処理が完了するのを待ちます。 --sha HEAD リポジトリ内でも動作します。以下の操作は避けてください --ref main プッシュ直後です。その時点でブランチにある最新のパイプラインが 採用されますが、Codeがまだそのプッシュ用のパイプラインを 作成していない場合、前回のコミットのパイプラインが使用される可能性があり、その結果、誤った結果に基づいてデプロイしてしまうことになります。

Terminal window
champrep code pipelines wait acme/web --ref main # the newest pipeline on main now
champrep code pipelines wait acme/web 9921 --timeout 30m # one pipeline

パイプラインを実行し、その完了を待ちます:

Terminal window
ID=$(champrep code pipelines run acme/web --ref main --yes --json | jq -r .id)
champrep code pipelines wait acme/web "$ID"

進行状況と最終ステータス行は stderr に出力されます。 --json、stdoutには 完了したパイプラインが格納され、終了コードは変わりません:

Terminal window
champrep code pipelines wait acme/web "$ID" --json | jq -r '"\(.status) \(.web_url)"'

手動で開始するデプロイなど、手動ジョブに到達したパイプラインは、 人が操作を行うまでそこで停止します。 pipelines wait 終了 1 その旨を伝える メッセージを表示します。ジョブを次のように開始します。 champrep code jobs play、または渡す --manual-ok パイプラインを完了とみなすには(終了 0)。スケジュールされた (遅延)ジョブは自動的に開始されるため、その間も待機状態が続きます。

代わりに1つのジョブを監視するには、そのログを追跡してください。ジョブが 完了して終了すると、コマンドは返ります 1 ジョブが失敗またはキャンセルされた場合:

Terminal window
champrep code jobs log acme/web 4182 --follow

パイプラインの再試行またはキャンセル

Section titled “パイプラインの再試行またはキャンセル”
Terminal window
champrep code pipelines retry acme/web 9921 --yes # reruns the failed and canceled jobs
champrep code pipelines cancel acme/web 9921 --yes

失敗したジョブのログを読み取り、実行中のジョブを追跡し、ジョブを再実行します

Section titled “失敗したジョブのログを読み取り、実行中のジョブを追跡し、ジョブを再実行します”
Terminal window
champrep code jobs ls acme/web --status failed --limit 5 # newest failed jobs
champrep code jobs ls acme/web --pipeline 9921 --status failed # failed jobs of one pipeline
champrep code jobs log acme/web 4180 --tail 100 # end of a log of any size
champrep code jobs log acme/web 4182 --follow # stream until the job ends
champrep code jobs retry acme/web 4180 --yes # run a finished job again
champrep code jobs play acme/web 4190 --var DEPLOY=staging --yes # start a manual job

スクリプトのバリエーションとして、パイプライン内のすべての失敗したジョブの 最後の30行を出力します:

Terminal window
for J in $(champrep code jobs ls acme/web --pipeline 9921 --status failed --json | jq -r '.[].id'); do
echo "=== job $J"
champrep code jobs log acme/web "$J" --tail 30
done

マージリクエストを開いてマージする

Section titled “マージリクエストを開いてマージする”
Terminal window
git push -u origin feature/login
champrep code mr create acme/web --source feature/login --target main \
--title "Add login page" --remove-source-branch --yes
champrep code mr show acme/web 12 # merge status and head pipeline
champrep code mr approve acme/web 12 --yes
champrep code mr merge acme/web 12 --auto --squash --yes # merges when the pipeline succeeds

スクリプトのバリエーション:新しいマージリクエストの番号を取得する方法:

Terminal window
IID=$(champrep code mr create acme/web --source feature/login --target main \
--title "Add login page" --yes --json | jq -r .iid)
champrep code mr merge acme/web "$IID" --auto --yes

Webアプリが必要な機能。 マージまたは承認を行う際は、 保護されたブランチ これは、ブラウザで CodeCHAMPREP にログインしているあなただけが下せる決定です。 その後CLI、は needs your web session … (SESSION_REQUIRED) そして終了 コード 1。CLIに再度CLIログインしても、この状態は変わりません。ブラウザでマージ リクエストを開き、そこでマージまたは承認を行ってください。保護されていないブランチは CLIから操作可能ですCLI。

ランナー:一覧表示、オンライン状態の確認、タグ付け、一時停止、再開

Section titled “ランナー:一覧表示、オンライン状態の確認、タグ付け、一時停止、再開”
Terminal window
champrep code runners ls # project and group runners you manage
champrep code runners ls --project acme/web # runners the project can use (Maintainer)
champrep code runners ls --group acme # the group's runners (Owner)
champrep code runners ls --status online # who is online now
champrep code runners ls --status offline --active # offline but not paused: worth a look
champrep code runners show 41 # status, online, tags, paused, machines
champrep code runners update 41 --add-tag docker --remove-tag old --yes
champrep code runners update 41 --tags linux,arm64 --yes # replace the whole list
champrep code runners update 41 --pause --yes # stop taking new jobs
champrep code runners update 41 --resume --yes

--add-tag そして --remove-tag ランナーのタグを読み取り、リスト全体を 書き戻します。この2つのステップの間に誰かがタグを変更した場合、その変更は 失われてしまいますので、複数の人がランナーを管理している場合は確認してください。 runners show 複数のユーザーがランナーを管理している場合は、必ず確認してください。

スクリプトによるバリエーション:メンテナンス前に、タグが付いたすべてのランナーを一時停止します:

Terminal window
champrep code runners ls --tag gpu --active --limit 500 --json | jq -r '.[].id' \
| xargs -I{} champrep code runners update {} --pause --yes

プロジェクトのランナーを表示・変更するには「Maintainer」権限が必要で、 グループのランナーについては「Owner」権限が必要です。インスタンスのランナーは、インスタンス管理者が (runners ls --all).

からプロジェクトまたはグループランナーを作成しCLI、 champrep-code-runner。トークン(ccrt_…) は標準 出力に一度だけ表示され、ログには記録されません。これを作成するには常に --yes.

Terminal window
champrep code runners create --project acme/web --description "build box" \
--tags linux,docker --yes --json \
| jq -r .token \
| champrep-code-runner register --url https://code.champrep.com --token-stdin \
--executor docker --docker-image alpine:3.24

使用方法 --group acme の代わりに --project (グループランナーの場合、オーナー権限が必要です)。 追加 --no-untagged タグ付けされたジョブのみを対象とし、 --protected 保護されたブランチとタグのみを実行します。また、Webアプリ内の [ランナー] セクションでランナーを作成することも可能です。 [設定] > [CI/CD] > [ランナー] を参照してください。 ランナーを登録する.

この では、ランナーのトークンをリセットしたり、インスタンスランナーを作成したりすることはCLIできません。これらについては、 Web アプリで行ってください。

Terminal window
champrep rf accounts show # the farm account, who it bills, the monthly ceiling
champrep rf usage # credits and minutes for the current period
champrep rf usage --period 2026-10 # a past month
champrep rf usage --json # { "balance": …, "usage": …, "period": "YYYY-MM" }

プールと待機中のジョブを確認する

Section titled “プールと待機中のジョブを確認する”
Terminal window
champrep rf connections ls
champrep rf pools ls
champrep rf pools show pol_01HZX9K4
champrep rf jobs ls --state waiting,held

各プールの稼働状況を示すスクリプトのバリエーション:

Terminal window
champrep rf pools ls --json | jq -r '.pools[] | "\(.id) \(.state) \(.busy)/\(.max_concurrent)"'

Terminal window
champrep rf pools update pol_01HZX9K4 --max-concurrent 8 --min-idle 2 --yes # scale up
champrep rf pools update pol_01HZX9K4 --max-concurrent 2 --min-idle 0 --yes # scale down
champrep rf pools update pol_01HZX9K4 --pause --yes # maintenance
champrep rf pools update pol_01HZX9K4 --resume --yes
champrep rf pools create --connection con_01HZX7 --name Builds \
--class build-4 --max-concurrent 4 --timeout 2h --yes # a new pool

--min-idle ウォームランナーを常時稼働させておくことで、ジョブの起動が速くなりますが、ウォームランナーの 使用にはクレジットが消費されます。ご利用のプランには、使用可能なクラス数や制限が設定されています。

ランナーファームのランナートークン、コネクタのシークレット、およびペアリング情報は、Web アプリ内の に保存されます https://runners.champrep.com。 どのようなキーを使用しても、 にはアクセスCLIできません。

Terminal window
champrep qa repos available --provider code # CHAMPREP Code projects and their QA keys
REPO="code:$(champrep code projects show acme/web --json | jq -r .id)"
champrep qa repos activate "$REPO" --yes

スキャンを行い、結果を待ちます

Section titled “スキャンを行い、結果を待ちます”
Terminal window
champrep qa scan "$REPO" --ref main --watch --yes # exits 1 when the scan or its gate fails
champrep qa scans ls --repo "$REPO" --limit 5

重大度の高い検出結果の一覧表示

Section titled “重大度の高い検出結果の一覧表示”
Terminal window
champrep qa findings ls --repo "$REPO" --severity critical,high
champrep qa findings ls --severity high --type secret # leaked secrets, whole workspace
champrep qa findings show QA-0970

スクリプトのバリエーション:

Terminal window
champrep qa findings ls --repo "$REPO" --severity critical,high --json | jq -r '.[] | "\(.qaId) \(.title)"'

品質ゲートに失敗した場合、CIを失敗させる

Section titled “品質ゲートに失敗した場合、CIを失敗させる”

champrep qa gates status 終了 1 ゲートが失敗した際に読み取るため、あらゆる パイプラインステップを保護できます。CodeCHAMPREP(.chpcode-ci.yml):

qa-gate:
stage: test
image: alpine:3.20
variables:
QA_REPO: "code:7d0c5c6e-0b6a-4e2b-9a55-0f8e6c1d2a10"
before_script:
- apk add --no-cache curl
- curl -fsSL https://cli.champrep.com/install.sh | sh
- export PATH="$HOME/.local/bin:$PATH"
script:
# CHAMPREP_TOKEN is a masked, protected CI variable holding an API key
# with the qa:read scope.
- champrep qa gates status "$QA_REPO" --branch "$CI_COMMIT_REF_NAME"

同じジョブは、 GitLab .gitlab-ci.yml。まずスキャンを行い、その後 ゲート処理を行う場合は、キーを指定してください qa:write も読み込み、実行するには:

script:
- champrep qa scan "$QA_REPO" --ref "$CI_COMMIT_REF_NAME" --watch --timeout 20m --yes

スキャンにはQA割り当てが消費されるため、多くのチームではデフォルトブランチと マージリクエストのみをスキャン対象とし、それ以外の場所ではゲートチェックのみを行っています。

CIおよびスクリプトでのCLI の使用

Section titled “CIおよびスクリプトでのCLI の使用”

どの認証情報か。 使用しないでください champrep auth login CI内のキーを作成します。ブラウザセッションCLIでCLIにサインインした状態でスコープ API付きキーを作成し、 「」という名前の、マスクされ保護されたCI変数として保存してください。CLIはキーチェーンの代わりにその 変数を使用します。 ジョブの動作 コードの読み取り:プロジェクト、パイプライン、ジョブログ、ランナー CHAMPREP_TOKEN。 は、キーチェーンの代わりにその 変数を使用CLIします。

Terminal window
champrep keys create --name "CI: acme/web" --scope code:read_api --scope qa:read --expires-in-days 90
ジョブの動作スコープ
コードの読み取り:プロジェクト、パイプライン、ジョブログ、ランナーcode:read_api
Codeの変更:パイプラインの実行、ジョブの再試行、MRの作成とマージ、ランナーの更新code:api
「ランナーファーム」を参照/プールを変更するrunner_farm:read / runner_farm:write
QAゲートと検出結果の確認/スキャンの開始、リポジトリの有効化qa:read / qa:write

ジョブに必要な権限のみを付与してください。キーでは、CodeCHAMPREP の管理、Runner Farmの認証情報、またはWeb セッションを必要とする機能にはアクセスできません。

プロンプトはありません。 ターミナルがない場合、何かを変更するコマンドは、 引数を指定しない限り実行されません。 --yes (-y)、何も送信されません。追加してください --yes を スクリプト内のすべての書き込みに適用します。 champrep code clone プロンプトは表示されず、以下の操作も不要です --yes.

機械可読な出力。 追加 --json そして、以下で解析してください: jq。終了 コードは、 --json。人間が読めるテキストを解析しないでください。

終了コード。

コード意味CIにおける典型的なアクション
0成功。続行してください。
1失敗または拒否:ゲートの失敗、スキャンの失敗、パイプラインまたは追跡中のジョブの失敗、クローンの失敗、アイテムへのアクセス不可、プランに含まれていない、役割の問題、Web セッションを必要とする決定、または欠落している --yes.ジョブを失敗させます。メッセージをご確認ください。
3ログインしていないか、キーが無効または取り消されています。修正 CHAMPREP_TOKEN.
4キーにスコープが指定されていません。キーにスコープを追加してください。
5レート制限または容量。後で再試行してください。
6ネットワーク障害。再試行してください。
7ゲートウェイまたはサービスの障害。後で再試行してください。
8pipelines wait が不足しました --timeout;パイプラインはまだ実行中です。再度待機するか、または --timeout.

詳しくは、 コマンドリファレンス および API 自動化用のキー.