वेंडर मोड

वेंडर मोड एक ऐसी सुविधा है जिसकी मदद से, बाहरी डिपेंडेंसी की लोकल कॉपी बनाई जा सकती है. यह सुविधा, ऑफ़लाइन बिल्ड के लिए या बाहरी डिपेंडेंसी के सोर्स को कंट्रोल करने के लिए काम की है.

वेंडर मोड चालू करना

--vendor_dir फ़्लैग तय करके, वेंडर मोड चालू किया जा सकता है.

उदाहरण के लिए, इसे अपनी .bazelrc फ़ाइल में जोड़कर:

# Enable vendor mode with vendor directory under <workspace>/vendor_src
common --vendor_dir=vendor_src

वेंडर डायरेक्ट्री, आपके वर्कस्पेस रूट का कोई रिलेटिव पाथ या कोई ऐब्सलूट पाथ हो सकती है.

किसी खास बाहरी डेटाबेस को वेंडर करना

वेंडर करने के लिए, vendor कमांड के साथ --repo फ़्लैग का इस्तेमाल किया जा सकता है. इससे यह तय किया जा सकता है कि किस डेटाबेस को वेंडर करना है. यह कैननिकल डेटाबेस का नाम और डेटाबेस का असली नाम, दोनों स्वीकार करता है.

उदाहरण के लिए, इसे चलाने पर:

bazel vendor --vendor_dir=vendor_src --repo=@rules_cc

या

bazel vendor --vendor_dir=vendor_src --repo=@@rules_cc+

दोनों ही स्थितियों में, rules_cc को <workspace root>/vendor_src/rules_cc+ के तहत वेंडर किया जाएगा.

दिए गए टारगेट के लिए, बाहरी डिपेंडेंसी वेंडर करना

दिए गए टारगेट पैटर्न बनाने के लिए ज़रूरी सभी बाहरी डिपेंडेंसी को वेंडर करने के लिए, आप bazel vendor <target patterns> चला सकते हैं.

उदाहरण के लिए

bazel vendor --vendor_dir=vendor_src //src/main:hello-world //src/test/...

मौजूदा कॉन्फ़िगरेशन के साथ, //src/main:hello-world टारगेट और //src/test/... के तहत सभी टारगेट बनाने के लिए ज़रूरी सभी डेटाबेस को वेंडर किया जाएगा.

बैकग्राउंड में, यह टारगेट पैटर्न का विश्लेषण करने के लिए, bazel build --nobuild कमांड चलाता है. इसलिए, इस कमांड पर बिल्ड फ़्लैग लागू किए जा सकते हैं और इससे नतीजे पर असर पड़ सकता है.

टारगेट को ऑफ़लाइन बनाना

बाहरी डिपेंडेंसी को वेंडर करने के बाद, टारगेट को ऑफ़लाइन बनाया जा सकता है. इसके लिए

bazel build --vendor_dir=vendor_src //src/main:hello-world //src/test/...

बिल्ड, नेटवर्क ऐक्सेस और डेटाबेस कैश के बिना, साफ़-सुथरे बिल्ड एनवायरमेंट में काम करना चाहिए.

इसलिए, वेंडर किए गए सोर्स को चेक इन किया जा सकता है और दूसरे डिवाइस पर, ऑफ़लाइन तरीके से एक ही टारगेट बनाए जा सकते हैं.

सभी बाहरी डिपेंडेंसी वेंडर करना

ट्रांज़िटिव बाहरी डिपेंडेंसी ग्राफ़ में मौजूद सभी डेटाबेस को वेंडर करने के लिए, यह कमांड चलाया जा सकता है:

bazel vendor --vendor_dir=vendor_src

ध्यान दें कि सभी डिपेंडेंसी को वेंडर करने के कुछ नुकसान हैं:

• सभी डेटाबेस को फ़ेच करने में ज़्यादा समय लग सकता है. इनमें वे डेटाबेस भी शामिल हैं जो ट्रांज़िटिव तरीके से जोड़े गए हैं.
• वेंडर डायरेक्ट्री बहुत बड़ी हो सकती है.
• अगर कुछ डेटाबेस, मौजूदा प्लैटफ़ॉर्म या एनवायरमेंट के साथ काम नहीं करते हैं, तो उन्हें फ़ेच नहीं किया जा सकता.

इसलिए, सबसे पहले खास टारगेट के लिए वेंडर करने पर विचार करें.

VENDOR.bazel की मदद से, वेंडर मोड कॉन्फ़िगर करना

वेंडर डायरेक्ट्री में मौजूद VENDOR.bazel फ़ाइल की मदद से, यह कंट्रोल किया जा सकता है कि दिए गए डेटाबेस को कैसे हैंडल किया जाए.

दो डायरेक्टिव उपलब्ध हैं. दोनों में, कैननिकल डेटाबेस के नामों की सूची को आर्ग्युमेंट के तौर पर स्वीकार किया जाता है:

• ignore(): किसी डेटाबेस को वेंडर मोड से पूरी तरह से अनदेखा करने के लिए.
• pin(): किसी डेटाबेस को उसके मौजूदा वेंडर किए गए सोर्स पर पिन करने के लिए. ऐसा तब किया जाता है, जब इस डेटाबेस के लिए --override_repository फ़्लैग मौजूद हो. वेंडर कमांड चलाने पर, Bazel इस डेटाबेस के लिए वेंडर किए गए सोर्स को अपडेट नहीं करेगा. हालांकि, ऐसा तब तक होगा, जब तक इसे अनपिन नहीं किया जाता. उपयोगकर्ता, इस डेटाबेस के लिए वेंडर किए गए सोर्स में मैन्युअल तरीके से बदलाव कर सकता है और उसे बनाए रख सकता है.

उदाहरण के लिए

ignore("@@rules_cc+")
pin("@@bazel_skylib+")

इस कॉन्फ़िगरेशन के साथ

• दोनों डेटाबेस को, इसके बाद की वेंडर कमांड से बाहर रखा जाएगा.
• डेटाबेस bazel_skylib को, वेंडर डायरेक्ट्री में मौजूद सोर्स से बदल दिया जाएगा.
• उपयोगकर्ता, bazel_skylib के वेंडर किए गए सोर्स में सुरक्षित तरीके से बदलाव कर सकता है.
• bazel_skylib को फिर से वेंडर करने के लिए, उपयोगकर्ता को सबसे पहले पिन स्टेटमेंट को बंद करना होगा.

यह समझना कि वेंडर मोड कैसे काम करता है

Bazel, किसी प्रोजेक्ट की बाहरी डिपेंडेंसी को $(bazel info output_base)/external में फ़ेच करता है. बाहरी डिपेंडेंसी को वेंडर करने का मतलब है कि काम की फ़ाइलों और डायरेक्ट्री को, दी गई वेंडर डायरेक्ट्री में ले जाना और बाद के बिल्ड के लिए, वेंडर किए गए सोर्स का इस्तेमाल करना.

वेंडर किए जा रहे कॉन्टेंट में ये चीज़ें शामिल हैं:

• डेटाबेस डायरेक्ट्री
• डेटाबेस मार्कर फ़ाइल

बिल्ड के दौरान, अगर वेंडर की गई मार्कर फ़ाइल अप-टू-डेट है या डेटाबेस को VENDOR.bazel फ़ाइल में पिन किया गया है, तो Bazel, डेटाबेस के नियम को असल में चलाने के बजाय, वेंडर किए गए सोर्स का इस्तेमाल करता है. इसके लिए, वह $(bazel info output_base)/external में उसका सिमलिंक बनाता है. इसके अलावा, एक चेतावनी दिखती है और Bazel, डेटाबेस का नया वर्शन फ़ेच करने के लिए फ़ॉलबैक करेगा.

वेंडर रजिस्ट्री फ़ाइलें

Bazel को बाहरी डिपेंडेंसी फ़ेच करने के लिए, Bazel मॉड्यूल रिज़ॉल्यूशन करना पड़ता है. इसके लिए, इंटरनेट के ज़रिए रजिस्ट्री फ़ाइलों को ऐक्सेस करना पड़ सकता है. ऑफ़लाइन बिल्ड करने के लिए, Bazel नेटवर्क से फ़ेच की गई सभी रजिस्ट्री फ़ाइलों को <vendor_dir>/_registries डायरेक्ट्री में वेंडर करता है.

वेंडर सिमलिंक

बाहरी डेटाबेस में, अन्य फ़ाइलों या डायरेक्ट्री की ओर ले जाने वाले सिमलिंक हो सकते हैं. यह पक्का करने के लिए कि सिमलिंक सही तरीके से काम करें, Bazel, वेंडर किए गए सोर्स में सिमलिंक को फिर से लिखने के लिए, यह रणनीति अपनाता है:

• एक सिमलिंक <vendor_dir>/bazel-external बनाएं, जो $(bazel info output_base)/external की ओर ले जाता है. यह हर Bazel कमांड से अपने-आप रीफ़्रेश हो जाता है.
• वेंडर किए गए सोर्स के लिए, उन सभी सिमलिंक को फिर से लिखें जो असल में a $(bazel info output_base)/external में मौजूद किसी पाथ की ओर ले जाते हैं. इसके लिए, <vendor_dir>/bazel-external में कोई रिलेटिव पाथ इस्तेमाल करें.

उदाहरण के लिए, अगर असली सिमलिंक यह है

<vendor_dir>/repo_foo+/link  =>  $(bazel info output_base)/external/repo_bar+/file

तो इसे इस तरह से लिखा जाएगा

<vendor_dir>/repo_foo+/link  =>  ../../bazel-external/repo_bar+/file

कहां

<vendor_dir>/bazel-external  =>  $(bazel info output_base)/external  # This might be new if output base is changed

चूंकि <vendor_dir>/bazel-external को Bazel अपने-आप जनरेट करता है, इसलिए इसे .gitignore या इसके बराबर की किसी फ़ाइल में जोड़ने का सुझाव दिया जाता है, ताकि इसे चेक इन न किया जा सके.

इस रणनीति के तहत, वेंडर किए गए सोर्स में मौजूद सिमलिंक सही तरीके से काम करने चाहिए. भले ही, वेंडर किए गए सोर्स को किसी दूसरी जगह पर ले जाया गया हो या bazel आउटपुट बेस बदल दिया गया हो.