Orbit
ربط مستودع GitHub
Before Orbit can deploy anything from GitHub you install the Kapsule Orbit GitHub App on your GitHub account or organisation and choose which repositories it can see. This guide walks through the…
قبل أن يتمكن Orbit من نشر أي شيء من GitHub، يجب عليك تثبيت تطبيق Kapsule Orbit GitHub على حسابك على GitHub أو مؤسستك واختيار المستودعات التي يمكنه الوصول إليها. يرشدك هذا الدليل عبر التثبيت واختيار مستودع وإنشاء المشروع وما يجب فعله عندما لا يظهر مستودع تتوقعه.
قبل أن تبدأ
تحتاج إلى إذن لتثبيت تطبيق GitHub على الحساب أو المؤسسة التي تمتلك المستودع. على الحساب الشخصي يكون ذلك تلقائياً. على مؤسسة، تحتاج إما إلى أن تكون مالكاً، أو يحتاج مالك إلى الموافقة على طلب التثبيت الخاص بك من إعدادات المؤسسة.
الخطوة 1: تثبيت تطبيق Kapsule Orbit GitHub
- في KPanel، انقر على Orbit في الشريط الجانبي الأيسر.
- انقر على New project.
- اترك الوضع مضبوطاً على Import Git Repo.
- في الخطوة 1، انقر على Connect GitHub.
يتم إرسالك إلى GitHub لتثبيت تطبيق Kapsule Orbit. يسألك GitHub مكان تثبيته (حسابك الشخصي أو مؤسسة) ثم ما إذا كان يجب منح All repositories أو Only select repositories.
اختر Only select repositories وحدد فقط المستودعات التي تخطط لنشرها. يمكنك إضافة المزيد لاحقاً من GitHub دون قطع الاتصال أو إعادة إنشاء أي شيء في Orbit، مما يحافظ على نطاق التأثير للتكامل صغيراً.
عند الانتهاء، يرسلك GitHub إلى KPanel. تعرض الخطوة 1 الآن Just connected، وتُحمل مستودعاتك في الخطوة 2.
الخطوة 2: اختيار مستودع
تظهر المستودعات التي يمكنك الوصول إليها كقائمة. انقر على Select على المستودع الذي تريد نشره. تحمل المستودعات الخاصة شارة Private؛ ينشر Orbit المستودعات العامة والخاصة على حد سواء.
بعد التحديد، يعرض المستودع شارة Selected، وتسمح لك رابط Change باختيار مستودع مختلف.
إذا كان المستودع مفقوداً
يمكن لـ Orbit فقط أن يسرد ما يمكن لتطبيق GitHub رؤيته. إذا لم يكن المستودع الذي تتوقعه موجوداً:
- انقر على Reconnect GitHub في الخطوة 1 لإعادة تشغيل تدفق التثبيت، أو افتح github.com/settings/installations مباشرة.
- افتح تثبيت Kapsule Orbit وأضف المستودع المفقود تحت Repository access.
- عد إلى KPanel. تُحدّث القائمة.
إذا عرض لوحة التحكم No repos accessible، فهذا يعني تثبيت التطبيق ولكن لم تُمنح أي مستودعات على الإطلاق. افتح إعدادات تطبيق GitHub ومنح الوصول إلى مستودع واحد على الأقل.
الأسباب الشائعة الأخرى:
- المستودع ينتمي إلى organisation لم تثبت التطبيق عليها. تثبيته على حسابك الشخصي لا يغطي مستودعات المؤسسة.
- مالك المؤسسة لم يوافق بعد على طلب التثبيت الخاص بك. حتى يفعلوا ذلك، التطبيق موجود لكنه لا يرى شيئاً.
- تم نقل المستودع أو إعادة تسميته بعد تثبيت التطبيق. أعد تشغيل تدفق التثبيت لتحديث ما يمكن لـ Orbit رؤيته.
الخطوة 3: تكوين مشروعك
مع تحديد مستودع، تطلب الخطوة 3 حقلين:
| الحقل | ما يفعله |
|---|---|
| Project Name | اسم العرض في KPanel، على سبيل المثال my-app |
| Deploy URL | النطاق الفرعي تحت kaps.run، لذا يصبح my-app إلى my-app.kaps.run |
انقر على Create project. ينسخ Orbit المستودع ويضع أول بناء في قائمة الانتظار ويعيدك إلى نظرة عامة على المشروع حيث يمكنك مراقبة تدفق السجل.
تم تعيين slug عنوان النشر مرة واحدة عند الإنشاء ولا يمكن تغييره لاحقاً. إذا كنت تريد عنواناً عاماً مختلفاً لاحقاً، أرفق نطاقاً مخصصاً بدلاً من محاولة إعادة تسمية slug. راجع Adding a Custom Domain to Your Project.
ما يقوم Orbit بإعداده تلقائياً
ينشئ المشروع push-to-deploy لك. لا توجد webhook يجب تكوينها يدوياً:
- الدفع إلى فرع الإنتاج الخاص بك يضع نشر الإنتاج في قائمة الانتظار.
- إذا كان Branch previews مُفعلاً، فإن الدفع إلى أي فرع آخر ينشئ معاينة معزولة في
branch-<branch-name>.kaps.run. راجع Branch Preview Deployments in Orbit. - يتم تتبع نشاط طلب السحب، لذا تعرض نشر معاينة رقم PR الذي ينتمي إليه.
- يؤدي إغلاق أو دمج طلب سحب إلى إيقاف معاينته مؤقتاً، ويتم استرجاع التخزين في غضون يوم تقريباً.
بوابات النشر على GitHub Actions
إذا كنت تقوم بتشغيل الاختبارات في GitHub Actions فيمكنك جعل Orbit ينتظرها. في Settings، ثم CI required checks، أدخل أسماء وظائف Actions الدقيقة، مفصولة بفواصل، على سبيل المثال build,test,lint. يجب أن تمر جميع الفحوصات المسماة قبل متابعة نشر الإنتاج المُحفز بالدفع. يلغي فشل CI نشر Orbit تلقائياً.
ينطبق هذا على فرع الإنتاج فقط.
إعادة الاتصال أو تغيير التثبيت الخاص بك
لتغيير المستودعات التي يمكن لـ Orbit رؤيتها:
- انقر على Orbit، ثم New project.
- في الخطوة 1، انقر على Reconnect لإعادة تشغيل تدفق تثبيت تطبيق GitHub.
أو أدر التثبيت مباشرة على github.com/settings/installations. يتم التقاط التغييرات هناك في المرة التالية التي يسرد فيها Orbit مستودعاتك.
قطع اتصال GitHub
في الخطوة 1 من New project، انقر على Disconnect.
يؤدي قطع الاتصال إلى إزالة الرابط بين حسابك على Kapsule و GitHub. يتم الاحتفاظ بمشاريعك وسجل نشرها، والنشر الحالي المباشر يستمر في خدمة حركة المرور، لكن النشرات المُحفزة بالدفع تتوقف حتى تعيد الاتصال. تستمر خطافات النشر في العمل، لأنها تجلب رأس الفرع من خلال اتصال الموفر: إذا كان الاتصال قد اختفى، فإن استدعاء الخطاف يفشل مع خطأ بدلاً من نشر رمز قديم.
القراءة ذات الصلة
- Deploying Your Project لدورة النشر الكاملة والبوابات التي تتحكم فيها
- Configuring Your Build Command and Output Directory إذا فشل البناء الأول أو يخدم الشيء الخاطئ
- Connecting a GitLab Repo و Connecting a Bitbucket Repo للموفرين الآخرين