यह दस्तावेज़ फास्टलेन का उपयोग करके परीक्षकों को एपीके बिल्ड वितरित करने का वर्णन करता है, एक ओपन सोर्स प्लेटफ़ॉर्म जो आईओएस और एंड्रॉइड ऐप बनाने और जारी करने को स्वचालित करता है। यह दस्तावेज़ Fastfile
में परिभाषित निर्देशों का पालन करता है। आपके द्वारा फास्टलेन और अपने Fastfile
सेट करने के बाद, आप ऐप वितरण को अपने फास्टलेन कॉन्फ़िगरेशन के साथ एकीकृत कर सकते हैं।
शुरू करने से पहले
यदि आपने पहले से नहीं किया है, तो अपने Android प्रोजेक्ट में Firebase जोड़ें ।
यदि आप किसी अन्य फायरबेस उत्पाद का उपयोग नहीं कर रहे हैं, तो आपको केवल एक प्रोजेक्ट बनाना होगा और अपना ऐप पंजीकृत करना होगा। हालांकि, यदि आप भविष्य में अतिरिक्त उत्पादों का उपयोग करने का निर्णय लेते हैं, तो उपरोक्त लिंक किए गए पृष्ठ पर सभी चरणों को पूरा करना सुनिश्चित करें।
स्टेप 1. फास्टलेन सेट करें
अपने फास्टलेन कॉन्फ़िगरेशन में ऐप डिस्ट्रीब्यूशन जोड़ने के लिए, अपने Android प्रोजेक्ट के रूट से निम्न कमांड चलाएँ:
fastlane add_plugin firebase_app_distribution
यदि आदेश आपको एक विकल्प के साथ संकेत देता है, तो
Option 3: RubyGems.org
।
चरण 2. फायरबेस के साथ प्रमाणित करें
इससे पहले कि आप फास्टलेन प्लगइन का उपयोग कर सकें, आपको सबसे पहले निम्नलिखित में से किसी एक तरीके से अपने फायरबेस प्रोजेक्ट के साथ प्रमाणित करना होगा। यदि कोई अन्य प्रमाणीकरण विधि का उपयोग नहीं किया जाता है, तो डिफ़ॉल्ट रूप से, फास्टलेन प्लगइन फायरबेस सीएलआई से क्रेडेंशियल्स की तलाश करता है।
एक सेवा खाते के साथ प्रमाणीकरण करने से आप अपने निरंतर एकीकरण (CI) सिस्टम के साथ लचीले ढंग से प्लगइन का उपयोग कर सकते हैं। सेवा खाता क्रेडेंशियल प्रदान करने के दो तरीके हैं:
- अपनी सेवा खाता कुंजी फ़ाइल को
firebase_app_distribution
क्रिया में पास करें। यदि आपके पास पहले से ही आपके निर्माण वातावरण में आपकी सेवा खाता कुंजी फ़ाइल है, तो आपको यह विधि सुविधाजनक लग सकती है। - अपनी सेवा खाता कुंजी फ़ाइल को इंगित करने के लिए परिवेश चर
GOOGLE_APPLICATION_CREDENTIALS
सेट करें. यदि आपके पास पहले से ही किसी अन्य Google सेवा (जैसे, Google क्लाउड) के लिए कॉन्फ़िगर किए गए एप्लिकेशन डिफ़ॉल्ट क्रेडेंशियल्स (ADC) हैं, तो आप इस विधि को पसंद कर सकते हैं।
- Google क्लाउड कंसोल पर, अपनी परियोजना का चयन करें और एक नया सेवा खाता बनाएँ।
- फायरबेस ऐप डिस्ट्रीब्यूशन एडमिन रोल जोड़ें।
- एक निजी json कुंजी बनाएँ और कुंजी को अपने निर्माण वातावरण के लिए सुलभ स्थान पर ले जाएँ। इस फ़ाइल को कहीं सुरक्षित रखना सुनिश्चित करें , क्योंकि यह आपके फायरबेस प्रोजेक्ट में ऐप वितरण के लिए व्यवस्थापकीय पहुँच प्रदान करती है।
- यदि आपने अपना ऐप 20 सितंबर, 2019 के बाद बनाया है तो इस चरण को छोड़ दें: Google APIs कंसोल में, Firebase ऐप वितरण API को सक्षम करें। संकेत दिए जाने पर, अपने Firebase प्रोजेक्ट के समान नाम वाले प्रोजेक्ट का चयन करें।
अपना सेवा खाता क्रेडेंशियल प्रदान करें या उसका पता लगाएं:
- अपनी सेवा खाता कुंजी को अपनी लेन की
firebase_app_distribution
क्रिया में पास करने के लिए,service_credentials_file
पैरामीटर को अपनी निजी कुंजी JSON फ़ाइल के पथ के साथ सेट करें एडीसी के साथ अपने क्रेडेंशियल्स का पता लगाने के लिए, पर्यावरण चर
GOOGLE_APPLICATION_CREDENTIALS
को निजी कुंजी JSON फ़ाइल के पथ पर सेट करें। उदाहरण के लिए:export GOOGLE_APPLICATION_CREDENTIALS=/absolute/path/to/credentials/file.json
एडीसी के साथ प्रमाणीकरण के बारे में अधिक जानकारी के लिए, अपने आवेदन को क्रेडेंशियल प्रदान करना पढ़ें।
- अपनी सेवा खाता कुंजी को अपनी लेन की
अपने प्रोजेक्ट को प्रमाणित करने के तरीके के बारे में निर्देशों के लिए फायरबेस सीएलआई के साथ लॉग इन करें देखें।
स्टेप 3. अपना फास्टफाइल सेट करें और अपने ऐप को वितरित करें
- एक
./fastlane/Fastfile
लेन में, एकfirebase_app_distribution
ब्लॉक जोड़ें। वितरण को कॉन्फ़िगर करने के लिए निम्न पैरामीटर का उपयोग करें:firebase_app_distribution पैरामीटर app
आवश्यक : आपके ऐप की फायरबेस ऐप आईडी। आप सामान्य सेटिंग्स पृष्ठ पर, फायरबेस कंसोल में ऐप आईडी पा सकते हैं।
app: "1:1234567890:android:0a1b2c3d4e5f67890"
firebase_cli_token
एक रीफ्रेश टोकन जो तब प्रिंट होता है जब आप फायरबेस सीएलआई के साथ अपने सीआई पर्यावरण को प्रमाणित करते हैं (अधिक जानकारी के लिए सीआई सिस्टम के साथ सीएलआई का उपयोग करें पढ़ें)।
service_credentials_file
आपकी Google सेवा खाता json फ़ाइल का पथ। सेवा खाता क्रेडेंशियल्स का उपयोग करके प्रमाणित करने के तरीके के लिए ऊपर देखें।
android_artifact_type
Android फ़ाइल प्रकार (APK या AAB) निर्दिष्ट करता है।
android_artifact_path
apk_path
(बहिष्कृत) को प्रतिस्थापित करता है। आप जिस एपीके या एएबी फ़ाइल को अपलोड करना चाहते हैं, उसका निरपेक्ष पथ। यदि निर्दिष्ट नहीं है, तो फास्टलेन फ़ाइल के स्थान को उस लेन से निर्धारित करता है जिसमें फ़ाइल उत्पन्न हुई थी।release_notes
release_notes_file
इस बिल्ड के लिए रिलीज़ नोट।
आप या तो सीधे रिलीज़ नोट निर्दिष्ट कर सकते हैं:
release_notes: "Text of release notes"
या, सादा पाठ फ़ाइल का पथ निर्दिष्ट करें:
release_notes_file: "/path/to/release-notes.txt"
testers
testers_file
उन परीक्षकों के ईमेल पते जिन्हें आप आमंत्रित करना चाहते हैं।
आप परीक्षकों को ईमेल पतों की अल्पविराम से अलग की गई सूची के रूप में निर्दिष्ट कर सकते हैं:
testers: "ali@example.com, bri@example.com, cal@example.com"
या, आप ईमेल पतों की अल्पविराम से अलग की गई सूची वाली सादा पाठ फ़ाइल का पथ निर्दिष्ट कर सकते हैं:
testers_file: "/path/to/testers.txt"
groups
groups_file
वे परीक्षक समूह जिन्हें आप आमंत्रित करना चाहते हैं ( परीक्षकों को प्रबंधित करें देखें)। समूहों का उपयोग करके निर्दिष्ट किया गया है
समूह उपनाम , जिसे आप Firebase कंसोल में देख सकते हैं।आप समूहों को अल्पविराम से अलग की गई सूची के रूप में निर्दिष्ट कर सकते हैं:
groups: "qa-team, trusted-testers"
या, आप अल्पविराम से अलग की गई समूह नामों की सूची वाली सादा पाठ फ़ाइल का पथ निर्दिष्ट कर सकते हैं:
groups_file: "/path/to/groups.txt"
debug
एक बूलियन झंडा। वर्बोज़ डिबग आउटपुट प्रिंट करने के लिए आप इसे
true
पर सेट कर सकते हैं।
platform :android do desc "My awesome app" lane :distribute do build_android_app(...) # build_android_app is a built-in fastlane action. release = firebase_app_distribution( app: "1:123456789:android:abcd1234", testers: "tester1@company.com, tester2@company.com", release_notes: "Lots of amazing new features to test out!" ) end end
परीक्षकों को बिल्ड उपलब्ध कराने के लिए, अपनी लेन चलाएँ:
fastlane <lane>
कार्रवाई का वापसी मूल्य अपलोड की गई रिलीज का प्रतिनिधित्व करने वाला एक हैश है। यह हैश lane_context[SharedValues::FIREBASE_APP_DISTRO_RELEASE]
का उपयोग करके भी उपलब्ध है। इस हैश में उपलब्ध फ़ील्ड के बारे में अधिक जानकारी के लिए, REST API दस्तावेज़ीकरण देखें।
फास्टलेन प्लगइन रिलीज़ अपलोड के बाद निम्न लिंक को आउटपुट करता है। ये लिंक आपको बायनेरिज़ प्रबंधित करने में मदद करते हैं और यह सुनिश्चित करते हैं कि परीक्षकों और अन्य डेवलपर्स के पास सही रिलीज़ है:
- एकल रिलीज प्रदर्शित करने वाले फायरबेस कंसोल का लिंक। आप इस लिंक को अपने संगठन में अन्य डेवलपर्स के साथ साझा कर सकते हैं।
- टेस्टर एक्सपीरियंस (एंड्रॉइड नेटिव ऐप) में रिलीज़ का एक लिंक जो परीक्षकों को रिलीज़ नोट देखने और ऐप को अपने डिवाइस पर इंस्टॉल करने देता है। लिंक का उपयोग करने के लिए परीक्षक को रिलीज़ तक पहुंच की आवश्यकता होती है।
- एक हस्ताक्षरित लिंक जो ऐप बाइनरी (APK या AAB फ़ाइल) को सीधे डाउनलोड और इंस्टॉल करता है। लिंक एक घंटे के बाद समाप्त हो जाता है।
आपके बिल्ड को वितरित करने के बाद, यह 150 दिनों के लिए Firebase कंसोल के ऐप डिस्ट्रीब्यूशन डैशबोर्ड में उपलब्ध रहता है। जब बिल्ड समाप्त होने के 30 दिन बाद होता है, तो कंसोल में और उनके टेस्ट डिवाइस पर टेस्टर की सूची में एक समाप्ति नोटिस दिखाई देता है।
जिन परीक्षकों को पहले ऐप का परीक्षण करने के लिए आमंत्रित नहीं किया गया था, उन्हें आरंभ करने के लिए ईमेल आमंत्रण प्राप्त होते हैं। मौजूदा परीक्षकों को ईमेल सूचनाएँ प्राप्त होती हैं कि एक नया निर्माण परीक्षण के लिए तैयार है। परीक्षण ऐप इंस्टॉल करने का तरीका जानने के लिए, परीक्षक सेट अप मार्गदर्शिका देखें. आप यह निर्धारित करने के लिए प्रत्येक परीक्षक की स्थिति की निगरानी कर सकते हैं कि उन्होंने आमंत्रण स्वीकार किया है या नहीं और उन्होंने फायरबेस कंसोल में ऐप डाउनलोड किया है या नहीं।
(वैकल्पिक) हर बार जब आप ऐप वितरण में एक नई रिलीज़ बनाते हैं तो अपनी बिल्ड संख्या को स्वचालित रूप से बढ़ाने के लिए, आप firebase_app_distribution_get_latest_release
कार्रवाई का उपयोग कर सकते हैं और, उदाहरण के लिए, increment_version_code
फास्टलेन प्लगइन । निम्न कोड एक उदाहरण प्रदान करता है कि आपकी बिल्ड संख्या को स्वचालित रूप से कैसे बढ़ाया जाए:
lane :increment_version do
latest_release = firebase_app_distribution_get_latest_release(
app: "<your Firebase app ID>"
)
increment_version_code({ version_code: latest_release[:buildVersion].to_i + 1 })
end
firebase_app_distribution_get_latest_release
क्रिया के बारे में अधिक जानने के लिए, अपने ऐप की नवीनतम रिलीज़ के बारे में जानकारी प्राप्त करें देखें।
चरण 4 (वैकल्पिक)। वितरण के लिए परीक्षकों का प्रबंध करना
आप अपनी Fastfile
फ़ाइल का उपयोग करके या सीधे फास्टलेन क्रियाओं को चलाकर अपने ऐप रिलीज़ से परीक्षकों को जोड़ या हटा सकते हैं। चल रही क्रियाएं सीधे आपके Fastfile
में सेट मानों को ओवरराइड करती हैं।
एक बार आपके Firebase प्रोजेक्ट में परीक्षक जुड़ जाने के बाद, आप उन्हें अलग-अलग रिलीज़ में जोड़ सकते हैं। जिन परीक्षकों को आपके Firebase प्रोजेक्ट से हटा दिया गया है, उनके पास अब आपके प्रोजेक्ट में रिलीज़ तक पहुंच नहीं है, लेकिन वे कुछ समय के लिए आपकी रिलीज़ तक पहुंच बनाए रख सकते हैं।
Fastfile
प्रयोग करें
# Use lanes to add or remove testers from an app release. lane(:add_testers) do firebase_app_distribution_add_testers( emails: "foo@google.com,bar@google.com" # or file: "/path/to/testers.txt" ) end lane(:remove_testers) do firebase_app_distribution_remove_testers( emails: "foo@google.com,bar@google.com" # or file: "/path/to/testers.txt" ) end
# Add or remove testers with the terminal $ fastlane add_testers $ fastlane remove_testers
फास्टलेन क्रियाएं चलाएं
fastlane run firebase_app_distribution_add_testers emails:"foo@google.com,bar@google.com"
fastlane run firebase_app_distribution_remove_testers emails:"foo@google.com,bar@google.com"
आप --file="/path/to/testers.txt --emails
के बजाय --file="/path/to/testers.txt
उपयोग करके परीक्षकों को भी निर्दिष्ट कर सकते हैं।
firebase_app_distribution_add_testers
और firebase_app_distribution_remove_testers
कार्य भी निम्नलिखित तर्कों को स्वीकार करते हैं:
-
project_name
: आपका फायरबेस प्रोजेक्ट नंबर। -
service_credentials_file
: आपकी Google सेवा क्रेडेंशियल फ़ाइल का पथ। -
firebase_cli_token
: फायरबेस सीएलआई के लिए प्रामाणिक टोकन।
service_credentials_file
और firebase_cli_token
वही तर्क हैं जिनका उपयोग अपलोड क्रिया द्वारा किया जाता है।
चरण 5 (वैकल्पिक)। अपने ऐप की नवीनतम रिलीज़ के बारे में जानकारी प्राप्त करें
आप ऐप वितरण में अपने ऐप की नवीनतम रिलीज़ के बारे में जानकारी प्राप्त करने के लिए firebase_app_distribution_get_latest_release
क्रिया का उपयोग कर सकते हैं, जिसमें ऐप संस्करण की जानकारी, रिलीज़ नोट और निर्माण समय शामिल है। उपयोग के मामलों में स्वचालित रूप से संस्करण को बढ़ाना और पिछले रिलीज़ से रिलीज़ नोट्स को ले जाना शामिल है।
कार्रवाई का वापसी मूल्य एक हैश है जो नवीनतम रिलीज का प्रतिनिधित्व करता है। यह हैश lane_context[SharedValues::FIREBASE_APP_DISTRO_LATEST_RELEASE]
का उपयोग करके भी उपलब्ध है। इस हैश में उपलब्ध फ़ील्ड के बारे में अधिक जानकारी के लिए, REST API दस्तावेज़ीकरण देखें।
पैरामीटर
firebase_app_distribution_get_latest_release पैरामीटर | |
---|---|
app | आवश्यक : आपके ऐप की फायरबेस ऐप आईडी। आप सामान्य सेटिंग्स पृष्ठ पर, फायरबेस कंसोल में ऐप आईडी पा सकते हैं। app: "1:1234567890:android:0a1b2c3d4e5f67890" |
firebase_cli_token | एक रीफ्रेश टोकन जो तब प्रिंट होता है जब आप फायरबेस सीएलआई के साथ अपने सीआई पर्यावरण को प्रमाणित करते हैं (अधिक जानकारी के लिए सीआई सिस्टम के साथ सीएलआई का उपयोग करें पढ़ें)। |
service_credentials_file | आपकी Google सेवा खाता json फ़ाइल का पथ। सेवा खाता क्रेडेंशियल्स का उपयोग करके प्रमाणित करने के तरीके के लिए ऊपर देखें। |
debug | एक बूलियन झंडा। वर्बोज़ डिबग आउटपुट प्रिंट करने के लिए आप इसे |
अगले कदम
परीक्षकों के लिए आपके ऐप (स्क्रीनशॉट सहित) के बारे में फ़ीडबैक भेजना आसान बनाने के लिए इन-ऐप फ़ीडबैक लागू करें।
अपने ऐप के नए बिल्ड इंस्टॉल करने के लिए उपलब्ध होने पर अपने परीक्षकों को इन-ऐप अलर्ट प्रदर्शित करने का तरीका जानें।
CI/CD का उपयोग करके QA परीक्षकों को Android ऐप्स वितरित करने के सर्वोत्तम अभ्यास सीखें।