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

CHAMPREP أوامر الرموز

champrep code يعمل مع CHAMPREP Code من محطة العمل الخاصة بك: المشاريع و الفروع، والاستنساخ الجماعي، وطلبات الدمج، والمشكلات، وخطوط الأنابيب وسجلات المهام، و برامج تشغيل CI، والإصدارات. وهو يعمل نيابة عنك، باستخدام CLIتسجيل الدخول العادي الخاص بك، بحيث يطبق Code دورك في كل مشروع، وخطة الاشتراك الخاصة بك، وحصصك تمامًا كما يفعل تطبيق الويب.

  1. تثبيت CLI و تسجيل الدخول مع champrep auth login.
  2. يجب أن تتضمن خطتك CHAMPREPCode. إذا لم تكن كذلك، تتوقف الأوامر عند not available to your account (رمز الخروج 1).
Terminal window
champrep auth login
champrep code projects ls

تسمية المشاريع وطلبات الدمج والمشكلات

Section titled “تسمية المشاريع وطلبات الدمج والمشكلات”
  • PROJECT هو المسار الكامل للمشروع، مثل acme/web، أو معرّفه. يعد المسار أسهل طريقة للكتابة.
  • يتم ترقيم طلبات الدمج والمشكلات حسب كل مشروع. أدخل الرقم: 12 و !12 كلاهما يسمي طلب الدمج 12، و 34 و #34 كلا الاسمين المشكلة 34.
  • PIPELINE_ID و JOB_ID هي الأرقام التي تظهر بواسطة pipelines ls و jobs ls.

الأمرالغرض
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قم بإدراج مفاتيح SSH الموجودة في حساب Code الخاص بك.

code clone الخيارات:

  • --ssh، أو --https (الافتراضي)، يختار البروتوكول.
  • --dry-run تسرد ما سيحدث.
  • --parallel N تُجري N عملية git دفعة واحدة (الافتراضي 4، بحد أقصى 16).
  • --archived تشمل المشاريع المؤرشفة.
  • --update يقوم بجلب المشاريع التي تم استنساخها مسبقًا وتقديمها سريعًا بدلاً من تخطيها. الاستنساخ الذي origin يُبلغ عن مستودع آخر على أنه mismatch. يتم الإبلاغ عن HEAD منفصل أو فرع بدون مصدر أعلى على أنه no-upstream.
  • --search TEXT يحتفظ فقط بالمشاريع المطابقة.
  • --max-projects N تتعامل مع ما لا يزيد عن N مشروعًا (الافتراضي 1000)، يتم حسابها بعد الـ --owned مرشح.

يُطبع ملخصًا ثم يخرج 1 عندما يفشل أي مشروع أو يتم مقاطعة التشغيل (يوقف Ctrl-C عمليات النسخ الجديدة وتلك قيد التشغيل). مع --json يُطبع مدخلاً واحدًا لكل مشروع مع status.

لا يطلب النسخ الجماعي (bulk clone) أي إدخال أبدًا. يعمل git مع GIT_TERMINAL_PROMPT=0، وSSH يُشغَّل باستخدام BatchMode=yes ما لم تقم بتعيين GIT_SSH_COMMAND أو core.sshCommand بنفسك. فقط https:// ويتم استنساخ عناوين SSH على مضيف CHAMPREP Code، ويتم تشغيل git مع تعطيل جميع وسائل النقل الأخرى.

يقوم git بالمصادقة تلقائيًا. استخدم مفتاح SSH، أو رمز وصول شخصي محفوظ في مخزن بيانات الاعتماد الخاص بـ git، وكلاهما يتم إعدادهما مرة واحدة في تطبيق Code على الويب؛ انظر إعداد بيانات اعتماد git. لا تضع CLI أبدًا رمزًا في عنوان URL بعيد أو في .git/config.

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 عندما --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 ميغابايت يحتاج إلى --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_…) مرة واحدة على stdout ولا يسجله أبدًا. يحتاج دائمًا إلى --yes. الاسم المستعار register.

قم بتوصيل جهاز بمشغل جديد باستخدام champrep-code-runner register. تتم إعادة تعيين رمز المشغل وإنشاء مثيلات المشغلات داخل التطبيق الويب.

الأمرالغرض
champrep code releases ls PROJECTسرد الإصدارات، الأحدث أولاً. --limit.

تعرض القوائم 20 صفًا بشكل افتراضي. قم بزيادة --limit (حتى 500) لرؤية المزيد؛ ويشير إلى CLI ذلك عند وجود المزيد من الصفوف، وعند --limit 500 يطلب منك تضييق المعايير بدلاً من ذلك. jobs ls --pipeline ID --status S تقوم بضبط المعايير من جانبك بعد قراءة أول 500 مهمة في خط الأنابيب، وتُعلمك عند وجود المزيد.

توجد المزيد من الإرشادات لكل مهمة على حدة، مع متغيرات البرمجة النصية، في المهام الشائعة.

انسخ مجموعة كاملة، مع مجموعاتها الفرعية، وحافظ على تحديثها:

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

انسخ مشروعًا وافتح طلب دمج لفرعك:

Terminal window
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

راجع طلبات الدمج المفتوحة وقم بدمج أحدها عندما يجتاز مسارها:

Terminal window
champrep code mr ls acme/web
champrep code mr show acme/web 12
champrep code mr merge acme/web 12 --auto --squash --yes

قم بتشغيل مسار، وانتظر حتى ينتهي، وتابع سجل المهمة:

Terminal window
champrep code pipelines run acme/web --ref main --var DEPLOY=staging --yes
champrep code pipelines wait acme/web --ref main && echo "main is green"
champrep code pipelines ls acme/web --ref main --limit 5
champrep code pipelines show acme/web 9921
champrep code jobs log acme/web 4182 --follow

ابحث عن المهام الفاشلة وأعد محاولة واحدة منها:

Terminal window
champrep code jobs ls acme/web --status failed
champrep code jobs log acme/web 4180 --tail 50
champrep code jobs retry acme/web 4180 --yes

تتبع المشكلات:

Terminal window
champrep code issues ls acme/web --labels bug --search login
champrep code issues create acme/web --title "Login fails on Safari" --labels bug,web
champrep 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 حجة المشروع أو طلب الدمج أو المشكلة أو مسار العمل أو المهمة التي تحتوي على a . أو .. مقطع المسار قبل إرسال أي شيء.

إضافة --json لطباعة الرمز الذي تم إرجاعه: تسرد الأوامر print مصفوفة JSON من العناصر، pipelines show يُطبع { "pipeline": …, "jobs": [ … ] }.

Terminal window
champrep code mr ls acme/web --json | jq -r '.[] | "\(.iid) \(.title)"'

الأخطاء التي قد تظهر لك

Section titled “الأخطاء التي قد تظهر لك”
رسالةماذا تفعل
needs your web session … (SESSION_REQUIRED)الدمج أو الموافقة في فرع محمي هو قرار لا يمكن أن يتخذه سواك، بعد تسجيل الدخول إلى تطبيق CodeCHAMPREP على الويب. افتح طلب الدمج في متصفحك وقم بدمجه أو الموافقة عليه من هناك. تعمل الفروع غير المحمية من 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 عندما تفشل المهمة أو يتم إلغاؤها. يقوم كل من «الانتظار» و«إعادة المحاولة» بشكل مستقل بالتعامل مع أخطاء الخدمة وحدود المعدل وأعطال الشبكة، ويستسلمان بعد ثماني محاولات متتالية.