GitHub Repo को कनेक्ट करना

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 Repo को कनेक्ट करने से पहले आपको Kapsule Orbit GitHub App को अपने GitHub अकाउंट या संगठन पर इंस्टॉल करना होगा और चुनना होगा कि वह कौन से repositories को देख सकता है। यह गाइड इंस्टॉल, repository चुनने, प्रोजेक्ट बनाने और यह देखने के बारे में है कि जब कोई repository जो आप चाहते हैं वह दिखाई न दे तो क्या करें।

शुरु करने से पहले

आपको GitHub App को उस अकाउंट या संगठन पर इंस्टॉल करने की अनुमति चाहिए जो repository के मालिक हैं। एक व्यक्तिगत अकाउंट पर यह स्वचालित है। एक संगठन पर आप या तो एक मालिक होने चाहिए, या एक मालिक को संगठन की सेटिंग्स से आपके इंस्टॉल अनुरोध को मंजूरी देनी चाहिए।

चरण 1: Kapsule Orbit GitHub App को इंस्टॉल करें

KPanel में, बाएं साइडबार में Orbit पर क्लिक करें।
New project पर क्लिक करें।
मोड को Import Git Repo पर सेट रहने दें।
चरण 1 पर, Connect GitHub पर क्लिक करें।

आप GitHub पर भेजे जाते हैं Kapsule Orbit ऐप को इंस्टॉल करने के लिए। GitHub पूछता है कि इसे कहां इंस्टॉल करना है (आपका व्यक्तिगत अकाउंट या एक संगठन) और फिर All repositories या Only select repositories को मंजूरी दे।

Only select repositories चुनें और केवल उन repositories को चेक करें जिन्हें आप डिप्लॉय करने की योजना बनाते हैं। आप बाद में GitHub से अधिक जोड़ सकते हैं बिना Orbit में किसी चीज को डिस्कनेक्ट या फिर से बनाए, और यह एकीकरण के blast radius को छोटा रखता है।

जब आप समाप्त करते हैं, GitHub आपको KPanel पर वापस भेजता है। चरण 1 अब Just connected दिखाता है, और आपकी repositories चरण 2 में लोड होती हैं।

चरण 2: एक Repository चुनें

आपकी सुलभ repositories एक सूची के रूप में दिखाई देती हैं। उस पर Select पर क्लिक करें जिसे आप डिप्लॉय करना चाहते हैं। निजी repositories एक Private बैज ले जाते हैं; Orbit सार्वजनिक और निजी repositories दोनों को डिप्लॉय करता है।

एक बार चुने जाने के बाद, repository एक Selected बैज दिखाता है, और एक Change लिंक आपको एक अलग चुनने देता है।

यदि एक Repository गायब है

Orbit केवल वही सूची बना सकता है जो GitHub App देख सकता है। यदि कोई repository जो आप चाहते हैं वह वहां नहीं है:

चरण 1 पर Reconnect GitHub पर क्लिक करें इंस्टॉल प्रवाह को फिर से चलाने के लिए, या सीधे github.com/settings/installations खोलें।
Kapsule Orbit इंस्टॉलेशन खोलें और Repository access के तहत लापता repository जोड़ें।
KPanel पर वापस लौटें। सूची ताजा हो जाती है।

यदि पैनल No repos accessible दिखाता है, ऐप इंस्टॉल है लेकिन किसी भी repositories को मंजूरी नहीं दी गई है। GitHub App सेटिंग्स खोलें और कम से कम एक को access दें।

अन्य सामान्य कारण:

Repository एक organisation से संबंधित है जिस पर आपने ऐप इंस्टॉल नहीं किया है। इसे अपने व्यक्तिगत अकाउंट पर इंस्टॉल करने से संगठन repositories कवर नहीं होती हैं।
एक संगठन मालिक ने अभी तक अनुमोदन नहीं किया आपके इंस्टॉल अनुरोध को। जब तक वे नहीं करते, ऐप मौजूद है लेकिन कुछ नहीं देखता है।
Repository को स्थानांतरित या नाम बदला गया आपने ऐप इंस्टॉल करने के बाद। Orbit जो देख सकता है उसे ताजा करने के लिए इंस्टॉल प्रवाह को फिर से चलाएं।

चरण 3: अपने प्रोजेक्ट को कॉन्फ़िगर करें

एक repository चुने जाने के साथ, चरण 3 दो फील्ड के लिए पूछता है:

फील्ड	यह क्या करता है
Project Name	KPanel में डिस्प्ले नाम, उदाहरण के लिए `my-app`
Deploy URL	`kaps.run` के तहत subdomain, तो `my-app` `my-app.kaps.run` बन जाता है

Create project पर क्लिक करें। Orbit repository को क्लोन करता है, आपके पहले build को कतार में डालता है, और आपको प्रोजेक्ट अवलोकन पर डालता है जहां आप लॉग स्ट्रीम को देख सकते हैं।

Deploy URL slug निर्माण के समय एक बार सेट होता है और बाद में परिवर्तित नहीं किया जा सकता है। यदि आप बाद में एक अलग सार्वजनिक पता चाहते हैं, तो slug का नाम बदलने की कोशिश करने के बजाय एक कस्टम डोमेन संलग्न करें। अपने प्रोजेक्ट में एक कस्टम डोमेन जोड़ना देखें।

Orbit स्वचालित रूप से क्या सेट करता है

प्रोजेक्ट बनाना आपके लिए push-to-deploy को वायर करता है। कोई webhook नहीं है जिसे आपको मैन्युअल रूप से कॉन्फ़िगर करना है:

आपकी production branch के लिए pushes एक production deployment को कतार में डालते हैं।
यदि Branch previews सक्षम है, किसी अन्य branch के लिए pushes branch-<branch-name>.kaps.run पर एक isolated preview बनाते हैं। Orbit में Branch Preview Deployments देखें।
Pull request activity को ट्रैक किया जाता है, तो एक preview deployment PR number दिखाता है जिससे वह संबंधित है।
एक pull request को बंद करना या merge करना इसके preview को रोकता है, और storage लगभग एक दिन में वापस ले लिया जाता है।

GitHub Actions पर Deploys को गेट करना

यदि आप GitHub Actions में परीक्षण चलाते हैं आप Orbit को उनकी प्रतीक्षा करने दे सकते हैं। Settings में, फिर CI required checks, सटीक Actions job नामों को दर्ज करें, comma-separated, उदाहरण के लिए build,test,lint। सभी नामित checks को एक push-triggered production deploy आगे बढ़ने से पहले पास करना चाहिए। एक CI failure Orbit deploy को स्वचालित रूप से रद्द कर देता है।

यह केवल production branch पर लागू होता है।

आपके इंस्टॉलेशन को फिर से कनेक्ट करना या बदलना

यह बदलने के लिए कि कौन सी repositories Orbit देख सकता है:

Orbit पर क्लिक करें, फिर New project।
चरण 1 पर, GitHub App install प्रवाह को फिर से चलाने के लिए Reconnect पर क्लिक करें।

या github.com/settings/installations पर सीधे इंस्टॉलेशन को प्रबंधित करें। वहां किए गए परिवर्तन अगली बार Orbit अपने repositories को सूचीबद्ध करता है तब उठाए जाते हैं।

GitHub को डिस्कनेक्ट करना

New project के चरण 1 पर, Disconnect पर क्लिक करें।

डिस्कनेक्ट करने से आपके Kapsule अकाउंट और GitHub के बीच लिंक हटाया जाता है। आपके प्रोजेक्ट और उनका deployment history रखा जाता है, और वर्तमान में live deployment ट्रैफिक परोसता रहता है, लेकिन push-triggered deployments तब तक रुकता है जब तक आप फिर से कनेक्ट नहीं करते। Deploy hooks काम करते रहते हैं, क्योंकि वे प्रदाता कनेक्शन के माध्यम से branch head को fetch करते हैं: यदि कनेक्शन चला गया है, एक hook call एक त्रुटि के साथ विफल हो जाता है बजाय stale code को डिप्लॉय करने के।