تخطَّ إلى المحتوى
Documentation

المهام الشائعة لـ Code و Runner Farm و QA

تحتوي هذه الصفحة على مجموعة من الوصفات القصيرة. كل وصفة تحل مهمة واحدة باستخدام أوامر يمكنك نسخها. وحيثما يكون البرنامج النصي مفيدًا، يوجد --json | jq النسخة البديلة. للاطلاع على كل علامة من علامات الأوامر، راجع الصفحات المرجعية: CHAMPREP Code, مزرعة المشغلات و CHAMPREP QA.

في الأمثلة، acme هي مجموعة، acme/web هو مشروع، و code.champrep.com هو CHAMPREP Code.

سجّل الدخول واختر حسابًا

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 على مفتاح تبديل منفصل لمساحة العمل. ينتمي المشروع إلى مجموعة أو إلى مساحة الاسم الشخصية الخاصة بك، ويحدد دورك فيه ما يمكنك القيام به.

تعمل «مزرعة المشغلات» و«ضمان الجودة» في مساحة عمل: حسابك الشخصي، أو منظمة، أو فريق. قم بإدراج تلك التي يمكنك استخدامها، ثم مرر 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 إلى هذه المشاريع، أو دع الخدمة تختار مساحة العمل بالطريقة التي يتبعها التطبيق الويب.

ابحث عن مشروع وعنوان استنساخه

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 مع CodeCHAMPREP مباشرةً، وليس عبر CLI، لذا فهو يحتاج إلى بيانات اعتماد خاصة به. لا يقبل CHAMPREPCode CLIتسجيل دخولك ككلمة مرور لـ git. يُعد إنشاء رمز وصول شخصي أو إضافة مفتاح SSH تغييرًا في بيانات الاعتماد، لذا فإنه يتطلب جلسة الويب التي قمت بتسجيل الدخول إليها. قم بذلك مرة واحدة في المتصفح.

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’s contrib/credential/libsecret المجلد. تحقق من command -v git-credential-libsecret. في حالة عدم وجود حلقة مفاتيح، تجنب استخدام store الأداة المساعدة، التي تكتب الرمز إلى ~/.git-credentials بنص عادي. استخدم cache --timeout=3600 بدلاً من ذلك، الذي يحتفظ به في الذاكرة فقط، أو استخدم SSH.

ثم انسخ مشروعًا واحدًا يدويًّا. يطلب 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 يرفض عناوين النسخ التي تحتوي على بيانات اعتماد.

انسخ كل مشروع أنت عضو فيه، سواء بشكل مباشر أو من خلال مجموعة، إلى ~/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

انسخ مجموعة واحدة، مع مجموعاتها الفرعية

Section titled “انسخ مجموعة واحدة، مع مجموعاتها الفرعية”
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 (مع "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، قم بأمرين :

  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:// ويتم استنساخ عناوين SSH على مضيف CHAMPREPCode، و يعمل 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 عندما تفشل المهمة أو يتم إلغاؤها:

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

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

ما الذي يحتاج إلى تطبيق الويب. الدمج أو الموافقة في فرع محمي هو قرار لا يمكن أن يتخذه سواك، بعد تسجيل الدخول إلى CodeCHAMPREP في المتصفح. ثمCLI يتوقف عند needs your web session … (SESSION_REQUIRED) والخروج الرمز 1. لا يؤدي تسجيل الدخول إلى 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 اقرأ علامات المشغل واكتب القائمة بأكملها مرة أخرى. إذا قام شخص ما بتغيير العلامات بين هاتين الخطوتين، فإن تغييره سيضيع، لذا تحقق من 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 لتشغيل الفروع والعلامات المحمية فقط. يمكنك أيضًا إنشاء المشغل في تطبيق الويب، تحت الإعدادات > CI/CD > المشغلات المشروع أو المجموعة. انظر تسجيل مشغل.

لاCLI يمكن لـ إعادة تعيين رمز المشغل أو إنشاء مشغلات مثيلات. قم بكلا الأمرين في التطبيق الويب.

التحقق من الاستخدام والرصيد

Section titled “التحقق من الاستخدام والرصيد”
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 يحافظ على جاهزية المشغلات الدافئة، بحيث تبدأ المهام بشكل أسرع، لكن المشغلات الدافئة تستهلك رصيدًا. تحدد خطتك الحد الأقصى للفئات والقيود التي يمكنك استخدامها.

تبقى رموز مشغلات مزرعة المشغلات وأسرار الموصلات وعمليات الاقتران في التطبيق الويب في 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 عند فشل عملية التحكم، بحيث يمكنها حماية أي خطوة في خط الأنابيب. في CHAMPREP Code (.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) الخاص بك، لذا تقوم العديد من الفرق بإجراء الفحص على الفرع الافتراضي و طلبات الدمج فقط، وتقوم بفحص البوابة في كل مكان آخر.

استخدام CLIفي CI والنصوص البرمجية

Section titled “استخدام CLIفي CI والنصوص البرمجية”

بيانات الاعتماد. لا تستخدم champrep auth login في CI. قم بإنشاء مفتاح محدد API النطاق أثناء تسجيل الدخول إلى CLI في جلسة متصفح، وقم بتخزينه كمتغير CI مخفي ومحمي باسم 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: تشغيل خطوط الأنابيب، إعادة محاولة المهام، فتح ودمج طلبات التغيير (MRs)، تحديث المشغلاتcode:api
اقرأ «مزرعة المشغلات» / تغيير المجموعاتrunner_farm:read / runner_farm:write
تحقق من بوابات ضمان الجودة والنتائج / ابدأ عمليات الفحص، وقم بتنشيط المستودعاتqa:read / qa:write

امنح فقط ما تحتاجه المهمة. لا يمكن للمفتاح الوصول إلى إدارة CodeCHAMPREP أو بيانات اعتماد مزرعة المشغلات، أو أي شيء يحتاج إلى جلسة الويب الخاصة بك.

لا توجد مطالبات. بدون محطة طرفية، أي أمر يُحدث تغييرًا ما يُرفض ما لم تمرر --yes (-y)، ولم يتم إرسال أي شيء. أضف --yes إلى كل عملية كتابة في البرنامج النصي. champrep code clone لا يطلب أبدًا ولا يحتاج إلى --yes.

مخرجات قابلة للقراءة آليًّا. إضافة --json وقم بتحليلها باستخدام jq. يظل رمز الخروج كما هو مع --json. لا تقم بتحليل النص المقروء بواسطة الإنسان.

رموز الخروج.

الرمزالمعنىالإجراء النموذجي في CI
0النجاح.تابع.
1فشل أو رفض: بوابة فاشلة، أو فحص فاشل، أو خط أنابيب أو مهمة متابعة لم تنجح، أو عملية استنساخ فاشلة، أو عدم القدرة على الوصول إلى العنصر، أو عدم تضمينه في خطتك، أو دورك، أو قرار يتطلب جلسة الويب الخاصة بك، أو ملف مفقود --yes.فشل المهمة؛ اقرأ الرسالة.
3لم يتم تسجيل الدخول، أو أن المفتاح غير صالح أو تم إلغاؤه.إصلاح CHAMPREP_TOKEN.
4المفتاح يفتقر إلى نطاق.أضف النطاق إلى المفتاح.
5حد السرعة أو السعة.أعد المحاولة لاحقًا.
6فشل الشبكة.أعد المحاولة.
7فشل البوابة أو الخدمة.أعد المحاولة لاحقًا.
8pipelines wait نفد --timeout؛ لا يزال خط الأنابيب قيد التشغيل.انتظر مرة أخرى، أو أبلغ عن المشكلة --timeout.

انظر مرجع الأوامر و API مفاتيح الأتمتة.