GitHub इंटीग्रेशन के साथ आप पुल रिक्वेस्ट, GitHub Actions के रन, एनवायरनमेंट और कमिट सीधे FeatValue में अपने कार्यों पर देखते हैं। आपके क्लाइंट आसान शब्दों में जानते हैं कि उनके बदलाव पर काम जारी है, वह टेस्ट के लिए staging पर है या लाइव है।
GitHub इंटीग्रेशन किसलिए है
सॉफ़्टवेयर कंपनियों और वेब एजेंसियों से बार बार एक ही सवाल पूछा जाता है: “क्या यह ऑनलाइन हो गया?” इंटीग्रेशन के साथ FeatValue इसका जवाब कार्य पर देता है:
- कार्य की ID वाली ब्रांच, कमिट और पुल रिक्वेस्ट सही कार्य पर दिखते हैं।
- GitHub Actions के रन और डिप्लॉयमेंट दिखाते हैं कि बदलाव टेस्ट हुआ है या नहीं और वह किस एनवायरनमेंट तक पहुँचा है।
- FeatValue महत्वपूर्ण चरणों को टिप्पणी के रूप में कार्य के इतिहास में लिखता है।
- हर प्रोजेक्ट के लिए आप तय करते हैं कि आपके क्लाइंट इसमें से क्या देखें।
- आप विफल रन सीधे FeatValue से दोबारा चलाते हैं।
अवलोकन के लिए GitHub इंटीग्रेशन का पेज देखें।
आवश्यकताएँ
- आपकी कंपनी का FeatValue खाता, जिसमें कम से कम एक क्लाइंट और प्रोजेक्ट हो (देखें परियोजनाएँ बनाना)
- github.com पर एक खाता या संगठन
- इस खाते या संगठन में ऐप इंस्टॉल करने का अधिकार। संगठनों में यह अधिकार owner के पास होता है। दूसरे सदस्य इंस्टॉलेशन का अनुरोध कर सकते हैं, और फिर कोई owner उसे GitHub में स्वीकृत करता है।
GitHub जोड़ें
-
ऐप खोलें
बाईं साइडबार में
अनुप्रयोग पर क्लिक करें,
GitHub चुनें और
इंस्टॉल करें पर क्लिक करें (देखें
अनुप्रयोग जोड़ें)।
-
GitHub से कनेक्ट करें
GitHub से कनेक्ट करें पर क्लिक करें। एक छोटा संदेश बताता है कि ऐप कौन सी अनुमतियाँ माँगता है (देखें
GitHub App की अनुमतियाँ)।
GitHub पर जारी रखें पर क्लिक करें।
-
GitHub में साइन इन करें
GitHub में साइन इन करें और FeatValue ऐप को अधिकृत करें।
-
ऐप इंस्टॉल करें या संगठन चुनें
अगर ऐप अभी कहीं इंस्टॉल नहीं है, तो GitHub सीधे इंस्टॉलेशन खोलता है: अपना खाता या कोई संगठन चुनें, फिर All repositories या Only select repositories में वे रिपॉज़िटरी चुनें जिन्हें FeatValue देख सके, और Install पर क्लिक करें। अगर ऐप पहले से कई संगठनों में इंस्टॉल है, तो आप एक चयन पेज पर वे संगठन चुनते हैं जिन्हें आप जोड़ना चाहते हैं। इसके बाद आप FeatValue पर वापस आ जाते हैं।
केवल उन्हीं रिपॉज़िटरी को पहुँच दें जिन्हें आप FeatValue प्रोजेक्ट से जोड़ना चाहते हैं। चुनाव आप कभी भी GitHub में FeatValue ऐप पर बदल सकते हैं: निजी खाते में Settings › Applications › Installed GitHub Apps में, संगठन में Organization settings › Third-party Access › GitHub Apps में।
GitHub App की अनुमतियाँ
FeatValue ऐप GitHub से ये अनुमतियाँ माँगता है:
- Metadata: read: पहुँच दी गई रिपॉज़िटरी के नाम और बुनियादी जानकारी
- Contents: read: कमिट और ब्रांच की तुलना
- Pull requests: read: शीर्षक, स्थिति और ब्रांच के साथ पुल रिक्वेस्ट
- Actions: read & write: GitHub Actions के रन पढ़ना, लिखना केवल रन दोबारा शुरू करने के लिए
- Deployments: read: डिप्लॉयमेंट और एनवायरनमेंट
GitHub App रिपॉज़िटरी की सामग्री पढ़ने की अनुमति (Contents: read) माँगता है, क्योंकि GitHub कमिट और ब्रांच की तुलना केवल इसी अनुमति से देता है। FeatValue इससे केवल कमिट की जानकारी (मैसेज, लेखक, समय) और ब्रांच की तुलना पढ़ता है, सोर्स कोड नहीं, और कोई फ़ाइल सेव नहीं करता।
रिपॉज़िटरी को प्रोजेक्ट से जोड़ें
हर रिपॉज़िटरी ठीक एक FeatValue प्रोजेक्ट से जुड़ी होती है। केवल जुड़ी हुई रिपॉज़िटरी FeatValue तक पहुँचती हैं।
-
रिपॉज़िटरी जोड़ें खोलें
-
रिपॉज़िटरी खोजें
जिन रिपॉज़िटरी तक आपने ऐप को पहुँच दी है, वे GitHub में रिपॉज़िटरी के तहत सूचीबद्ध हैं। सूची छोटी करने के लिए रिपॉज़िटरी खोजें का इस्तेमाल करें।
-
प्रोजेक्ट चुनें और जोड़ें
रिपॉज़िटरी के बगल में FeatValue प्रोजेक्ट चुनें और जोड़ें पर क्लिक करें। FeatValue पिछले कुछ दिनों का डेटा भी ले आता है। आपको कोई वेबहुक बनाने की ज़रूरत नहीं है, इवेंट FeatValue ऐप के ज़रिए आते हैं।
सभी कनेक्शन जुड़ी रिपॉज़िटरी के तहत सूचीबद्ध हैं। कॉलम अपडेट में वेबहुक से तुरंत दिखता है। बदलें से आप दूसरा प्रोजेक्ट चुनते हैं, और अलग करें से कनेक्शन हटाते हैं।
एक कनेक्शन में कई संगठन
FeatValue का एक कनेक्शन उन सभी GitHub संगठनों और खातों से ऐप का उपयोग कर सकता है जहाँ वह इंस्टॉल है और जिन तक जोड़ते समय आपकी पहुँच है, जैसे आपका अपना संगठन और आपके ग्राहकों के संगठन। रिपॉज़िटरी जोड़ें पेज की सूची संगठन के अनुसार समूहों में है।
-
संगठन जोड़ें
सेटिंग्स › GitHub (पेज रिपॉज़िटरी जोड़ें) खोलें और संगठन जोड़ें पर क्लिक करें।
-
संगठन चुनें
ऐसा संगठन चुनें जहाँ ऐप पहले से इंस्टॉल है। अगर वह नहीं दिखता, तो दूसरे संगठन में इंस्टॉल करें पर क्लिक करें और GitHub में वहाँ ऐप इंस्टॉल करें।
-
रिपॉज़िटरी जोड़ें
संगठन की रिपॉज़िटरी सूची में दिखती हैं। उन्हें ऊपर बताए तरीके से जोड़ें।
FeatValue की कई कंपनियाँ एक ही इंस्टॉलेशन का उपयोग कर सकती हैं, जैसे आपकी एजेंसी और आपका ग्राहक अपने FeatValue खाते के साथ।
कार्य की ID का सही इस्तेमाल
FeatValue में हर कार्य की एक ID होती है, जैसे abc123-4। यह आपको कार्य पर मिलती है। यह ID इनमें से किसी एक जगह लिखें:
| कहाँ |
उदाहरण |
| ब्रांच नाम |
abc123-4-contact-form |
| कमिट मैसेज |
abc123-4 Make phone number required |
| पुल रिक्वेस्ट का शीर्षक या विवरण |
Contact form: make phone number required (abc123-4) |
- बड़े और छोटे अक्षरों से फ़र्क नहीं पड़ता, और शुरुआत में
# लिखा जा सकता है।
- अगर ID ब्रांच नाम में है, तो केवल वे कमिट गिने जाते हैं जो सिर्फ़ इसी ब्रांच पर हैं। ब्रांच बनाते समय डिफ़ॉल्ट ब्रांच से साथ आए कमिट कार्य पर नहीं दिखते।
- दूसरी ब्रांच के कमिट तभी दिखते हैं जब ID उनके कमिट मैसेज में हो।
- ID केवल जुड़े हुए प्रोजेक्ट के भीतर लागू होती है। जो रिपॉज़िटरी किसी दूसरे प्रोजेक्ट से जुड़ी हैं या बिल्कुल नहीं जुड़ी हैं, उन्हें FeatValue कभी इस कार्य से नहीं जोड़ता।
- GitHub Actions के रन और डिप्लॉयमेंट उस कार्य के होते हैं, अगर वे उसकी किसी ब्रांच, कमिट या पुल रिक्वेस्ट के लिए चलते हैं।
कार्य पर क्या दिखता है
कार्य पर डेवलपमेंट सेक्शन एक छोटी पंक्ति के साथ दिखता है, जैसे: PR #12 मर्ज हुआ · Workflow सफल · Staging पर रोल आउट हुआ। खोलने के लिए विवरण दिखाएँ पर क्लिक करें:
- Workflow: GitHub Actions के रन, जैसे CI #57, उनके जॉब और स्थिति के साथ
- आपके डिप्लॉयमेंट से एनवायरनमेंट, खोलने के लिंक के साथ, जैसे Staging और Production
- Pull request, ब्रांच और कमिट
प्रोजेक्ट में क्या दिखता है
प्रोजेक्ट में डेवलपमेंट सेक्शन एनवायरनमेंट को उनके नवीनतम डिप्लॉयमेंट के साथ और डिफ़ॉल्ट ब्रांच का नवीनतम रन दिखाता है। नवीनतम workflow रन देखने के लिए सभी workflow रन दिखाएँ पर क्लिक करें। यहीं आपको प्रोजेक्ट की सेटिंग्स भी मिलती हैं।
क्लाइंट क्या देखते हैं?
प्रोजेक्ट में डेवलपमेंट सेक्शन की सेटिंग्स में क्लाइंट क्या देखते हैं? के तहत चुनें:
| सेटिंग |
आपका क्लाइंट देखता है |
| कुछ नहीं |
GitHub की कोई जानकारी नहीं |
| सरल स्थिति |
तकनीकी शब्दों के बिना एक वाक्य: काम जारी है, लिंक यहाँ टेस्ट करें के साथ Staging पर रोल आउट हुआ, या लिंक अभी देखें के साथ लाइव |
| विवरण |
वे सेक्शन जिन्हें आप क्लाइंट के लिए विवरण में चुनते हैं: कमिट, ब्रांच, pull request, workflow, एनवायरनमेंट और इतिहास टिप्पणियाँ |
आपकी कंपनी के जो लोग प्रोजेक्ट संपादित कर सकते हैं, वे यह सेटिंग बदल सकते हैं। इसके बाद आपका क्लाइंट कैसे टेस्ट और स्वीकृत करता है, यह समीक्षा और स्वीकृति में बताया गया है।
इतिहास टिप्पणियाँ सेट करना
FeatValue महत्वपूर्ण चरणों को टिप्पणी के रूप में कार्य के इतिहास में लिखता है। टास्क पर इतिहास टिप्पणियाँ में आप हर प्रोजेक्ट के लिए चुनते हैं कि किन इवेंट पर टिप्पणी बने:
- Pull request मर्ज हुआ
- Workflow सफल
- Workflow विफल (विफल जॉब के साथ)
- एनवायरनमेंट पर डिप्लॉय हुआ
अचयनित इवेंट कार्य पर स्थिति अपडेट करते रहते हैं, पर टिप्पणी नहीं बनाते। आपका क्लाइंट टिप्पणियाँ देखता है या नहीं, यह क्लाइंट क्या देखते हैं? की सेटिंग पर निर्भर करता है।
विफल रन दोबारा चलाएँ
Starter
जब GitHub Actions का कोई रन विफल या रद्द होता है, तो आप उसे सीधे FeatValue में दोबारा चलाते हैं। विफल रन में GitHub केवल विफल जॉब दोबारा चलाता है, रद्द हुए रन में पूरा रन। यह Starter प्लान से उपलब्ध है (देखें प्लान)।
-
वर्कफ़्लो की अनुमति दें
प्रोजेक्ट में डेवलपमेंट सेक्शन की सेटिंग्स खोलें। FeatValue से workflow फिर से चलाएँ में आपको वे वर्कफ़्लो मिलते हैं जिनके लिए GitHub अब तक किसी विफल रन की जानकारी दे चुका है, जैसे CI। जो वर्कफ़्लो FeatValue में दिखने चाहिए, उन्हें चुनें और सहेजें पर क्लिक करें।
-
क्लाइंट के लिए भी
अगर आपका क्लाइंट भी चुने गए वर्कफ़्लो दोबारा चला सके, तो क्लाइंट भी चुने गए workflow फिर से चला सकते हैं चुनें।
-
दोबारा चलाएँ
अनुमत वर्कफ़्लो का विफल रन फिर से चलाएँ बटन के साथ दिखता है। क्लिक के बाद FeatValue फिर से शुरू हुआ दिखाता है, और आगे की प्रगति आप रन पर देखते हैं।
सुरक्षा
- केवल पहुँच दी गई और जुड़ी हुई रिपॉज़िटरी: FeatValue ऐप केवल वही रिपॉज़िटरी देखता है जिन्हें आप इंस्टॉलेशन के समय पहुँच देते हैं। FeatValue कार्य की ID केवल उन रिपॉज़िटरी में जोड़ता है जिन्हें आपने किसी प्रोजेक्ट से जोड़ा है, और केवल उसी प्रोजेक्ट के भीतर।
- कोई सोर्स कोड नहीं: FeatValue केवल कमिट की जानकारी और ब्रांच की तुलना पढ़ता है, सोर्स कोड नहीं, और आपकी रिपॉज़िटरी की कोई फ़ाइल सेव नहीं करता। इसी के लिए ऐप Contents: read माँगता है (देखें GitHub App की अनुमतियाँ)।
- सत्यापित वेबहुक: GitHub FeatValue को भेजी गई हर डिलीवरी पर हस्ताक्षर करता है। FeatValue केवल वैध हस्ताक्षर वाली कॉल स्वीकार करता है।
- कम लिखने के अधिकार: ऐप केवल एक चीज़ बदल सकता है, GitHub Actions के रन दोबारा चलाना, और वह भी केवल उन वर्कफ़्लो के लिए जिनकी आपने अनुमति दी है।
- कभी भी अलग करें: अलग करें कनेक्शन हटाता है। अगर आप GitHub में ऐप अनइंस्टॉल करते हैं, तो FeatValue उस संगठन की रिपॉज़िटरी अपने आप अलग कर देता है।
कनेक्शन हटाएँ और ऐप अनइंस्टॉल करें
अगर आप FeatValue में GitHub का कनेक्शन हटाते हैं, तो FeatValue केवल रिपॉज़िटरी के कनेक्शन हटाता है। कार्यों पर जो पहले से दिख रहा है, वह बना रहता है। ऐप GitHub में तब तक इंस्टॉल रहता है जब तक आप उसे वहाँ अनइंस्टॉल नहीं करते:
- संगठन: GitHub में Organization settings › Third-party Access › GitHub Apps खोलें, FeatValue ऐप के पास Configure पर क्लिक करें और सबसे नीचे Uninstall पर क्लिक करें।
- निजी खाता: Settings › Applications › Installed GitHub Apps खोलें, FeatValue ऐप के पास Configure पर क्लिक करें और फिर Uninstall पर क्लिक करें।
अनइंस्टॉल करने के बाद FeatValue उस संगठन की रिपॉज़िटरी अपने आप अलग कर देता है।
समस्या निवारण
मेरी रिपॉज़िटरी सूची में नहीं है
FeatValue केवल वे रिपॉज़िटरी दिखाता है जिन तक आपने ऐप को पहुँच दी है। GitHub में Settings › Applications › Installed GitHub Apps खोलें, FeatValue ऐप चुनें और Repository access में रिपॉज़िटरी जोड़ें। संगठन के लिए यह सेटिंग संगठन की सेटिंग्स में मिलती है।
इंस्टॉलेशन स्वीकृति की प्रतीक्षा में है
अगर आप संगठन के owner नहीं हैं, तो GitHub इंस्टॉलेशन का अनुरोध owner को भेजता है। जैसे ही कोई owner इसे स्वीकृत करे, FeatValue में GitHub को फिर से जोड़ें।
कार्य पर कुछ नहीं दिखता
- क्या रिपॉज़िटरी उसी प्रोजेक्ट से जुड़ी है जिसका यह कार्य है?
- क्या कार्य की पूरी ID ब्रांच नाम, कमिट मैसेज या पुल रिक्वेस्ट में है?
- अगर GitHub की कोई डिलीवरी खो जाती है, तो FeatValue 10 मिनट के भीतर डेटा ले आता है।
कोई रन दोबारा नहीं चल पा रहा
दोबारा चलाना Starter प्लान से उपलब्ध है। साथ ही वर्कफ़्लो की प्रोजेक्ट सेटिंग्स में अनुमति होनी चाहिए, और रन विफल या रद्द हुआ होना चाहिए। अगर फिर से नहीं चलाया जा सका दिखे, तो GitHub में जाँचें कि ऐप अब भी इंस्टॉल है और रिपॉज़िटरी देख सकता है या नहीं।
चयन में कोई संगठन नहीं दिखता
FeatValue केवल वे संगठन दिखाता है जहाँ ऐप इंस्टॉल है और जिन तक आपके GitHub खाते की पहुँच है। दूसरे संगठन में इंस्टॉल करें से ऐप इंस्टॉल करें या संगठन के किसी owner से ऐसा करने को कहें।