शेल रूल

समस्या की शिकायत करें सोर्स देखें

नियम

sh_binary

नियम का सोर्स देखें
sh_binary(name, deps, srcs, data, args, compatible_with, deprecation, distribs, env, exec_compatible_with, exec_properties, features, licenses, output_licenses, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

sh_binary नियम का इस्तेमाल, एक्ज़ीक्यूटेबल शेल स्क्रिप्ट के बारे में बताने के लिए किया जाता है. (sh_binary गलत नाम है: इसके आउटपुट ज़रूरी नहीं हैं कि बाइनरी हों.) यह नियम पक्का करता है कि सभी डिपेंडेंसी बनाई गई हैं और निष्पादन के समय runfiles क्षेत्र में दिखाई देती हैं. हमारा सुझाव है कि आप अपने sh_binary() नियमों का नाम स्क्रिप्ट के नाम में से एक्सटेंशन हटाकर, उसके नाम पर रखें (उदाहरण के लिए, .sh); नियम का नाम और फ़ाइल का नाम अलग-अलग होना चाहिए. sh_binary शेबांग का सम्मान करता है, इसलिए किसी भी उपलब्ध अनुवादक का इस्तेमाल किया जा सकता है (जैसे कि #!/bin/zsh)

उदाहरण

बिना डिपेंडेंसी और कुछ डेटा फ़ाइलों वाली आसान शेल स्क्रिप्ट के लिए:

sh_binary(
    name = "foo",
    srcs = ["foo.sh"],
    data = glob(["datafiles/*.txt"]),
)

तर्क

विशेषताएं
name

नाम; ज़रूरी है

इस टारगेट के लिए यूनीक नाम.

deps

लेबल की सूची; डिफ़ॉल्ट [] है

इस टारगेट में एग्रीगेट की जाने वाली "लाइब्रेरी" टारगेट की सूची. ज़्यादातर बिल्ड नियमों में तय किए गए सामान्य एट्रिब्यूट पर deps के बारे में सामान्य टिप्पणियां देखें.

इस एट्रिब्यूट का इस्तेमाल, sh_library के उन दूसरे नियमों की सूची बनाने के लिए किया जाना चाहिए जो इंटरप्रेटेड प्रोग्राम सोर्स कोड देते हैं. यह कोड srcs में मौजूद कोड के आधार पर तय होता है. इन नियमों के मुताबिक दी गई फ़ाइलें इस टारगेट के runfiles में मौजूद होंगी.

srcs

लेबल की सूची; ज़रूरी है

शेल स्क्रिप्ट वाली फ़ाइल.

यह एट्रिब्यूट एक सिंगलटन सूची होनी चाहिए, जिसका एलिमेंट शेल स्क्रिप्ट है. यह स्क्रिप्ट एक्ज़ीक्यूटेबल होनी चाहिए. साथ ही, यह कोई सोर्स फ़ाइल या जनरेट की गई फ़ाइल हो सकती है. रनटाइम के दौरान ज़रूरी अन्य सभी फ़ाइलें (चाहे स्क्रिप्ट हों या डेटा), data एट्रिब्यूट में शामिल होती हैं.

sh_library

नियम का सोर्स देखें
sh_library(name, deps, srcs, data, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, restricted_to, tags, target_compatible_with, testonly, visibility)

इस नियम का मुख्य इस्तेमाल, मिलती-जुलती स्क्रिप्ट वाली लॉजिकल "लाइब्रेरी" को एक साथ इकट्ठा करने के लिए किया गया है. प्रोग्राम, इंटरप्रेटेड लैंग्वेज में है, जिसे बोर्न शेल जैसा कोई डेटा कंपाइल या लिंक करने की ज़रूरत नहीं होती. जैसे, बोर्न शेल. साथ ही, रन-टाइम के दौरान इन प्रोग्राम के लिए ज़रूरी डेटा. इसके बाद, ऐसी "लाइब्रेरी" का इस्तेमाल, एक या उससे ज़्यादा sh_binary नियमों के data एट्रिब्यूट से किया जा सकता है.

डेटा फ़ाइलें इकट्ठा करने के लिए, filegroup नियम का इस्तेमाल किया जा सकता है.

प्रोग्रामिंग की भाषाओं में, "कोड" और "डेटा" के बीच हमेशा साफ़ तौर पर अंतर नहीं होता: आखिरकार, अनुवादक के हिसाब से प्रोग्राम सिर्फ़ "डेटा" होता है. इस वजह से, इस नियम में तीन एट्रिब्यूट हैं, जो सभी एक जैसे हैं: srcs, deps, और data. लागू किया गया मौजूदा तरीका इन सूचियों के एलिमेंट में फ़र्क़ नहीं करता. तीनों एट्रिब्यूट के लिए, नियमों, सोर्स फ़ाइलों, और जनरेट की गई फ़ाइलों को स्वीकार किया जाता है. हालांकि, दूसरे नियमों की तरह ही एट्रिब्यूट का इस्तेमाल उनके सामान्य काम के लिए करना अच्छा तरीका है.

उदाहरण

sh_library(
    name = "foo",
    data = [
        ":foo_service_script",  # an sh_binary with srcs
        ":deploy_foo",  # another sh_binary with srcs
    ],
)

तर्क

विशेषताएं
name

नाम; ज़रूरी है

इस टारगेट के लिए यूनीक नाम.

deps

लेबल की सूची; डिफ़ॉल्ट [] है

इस टारगेट में एग्रीगेट की जाने वाली "लाइब्रेरी" टारगेट की सूची. ज़्यादातर बिल्ड नियमों में तय किए गए सामान्य एट्रिब्यूट पर deps के बारे में सामान्य टिप्पणियां देखें.

इस एट्रिब्यूट का इस्तेमाल, sh_library के उन दूसरे नियमों की सूची बनाने के लिए किया जाना चाहिए जो इंटरप्रेटेड प्रोग्राम सोर्स कोड देते हैं. यह कोड srcs में मौजूद कोड के आधार पर तय होता है. इन नियमों के मुताबिक दी गई फ़ाइलें इस टारगेट के runfiles में मौजूद होंगी.

srcs

लेबल की सूची; डिफ़ॉल्ट [] है

इनपुट फ़ाइलों की सूची.

इस एट्रिब्यूट का इस्तेमाल, इस लाइब्रेरी में मौजूद शेल स्क्रिप्ट की सोर्स फ़ाइलों को सूची में शामिल करने के लिए किया जाना चाहिए. स्क्रिप्ट, शेल के source या . कमांड का इस्तेमाल करके अन्य स्क्रिप्ट लोड कर सकती हैं.

sh_test

नियम का सोर्स देखें
sh_test(name, deps, srcs, data, args, compatible_with, deprecation, distribs, env, env_inherit, exec_compatible_with, exec_properties, features, flaky, licenses, local, restricted_to, shard_count, size, tags, target_compatible_with, testonly, timeout, toolchains, visibility)

sh_test() नियम, बॉर्न शेल स्क्रिप्ट के तौर पर लिखा गया टेस्ट बनाता है.

जांच के सभी नियमों (*_test) के लिए सामान्य एट्रिब्यूट देखें.

उदाहरण

sh_test(
    name = "foo_integration_test",
    size = "small",
    srcs = ["foo_integration_test.sh"],
    deps = [":foo_sh_lib"],
    data = glob(["testdata/*.txt"]),
)

तर्क

विशेषताएं
name

नाम; ज़रूरी है

इस टारगेट के लिए यूनीक नाम.

deps

लेबल की सूची; डिफ़ॉल्ट [] है

इस टारगेट में एग्रीगेट की जाने वाली "लाइब्रेरी" टारगेट की सूची. ज़्यादातर बिल्ड नियमों में तय किए गए सामान्य एट्रिब्यूट पर deps के बारे में सामान्य टिप्पणियां देखें.

इस एट्रिब्यूट का इस्तेमाल, sh_library के उन दूसरे नियमों की सूची बनाने के लिए किया जाना चाहिए जो इंटरप्रेटेड प्रोग्राम सोर्स कोड देते हैं. यह कोड srcs में मौजूद कोड के आधार पर तय होता है. इन नियमों के मुताबिक दी गई फ़ाइलें इस टारगेट के runfiles में मौजूद होंगी.

srcs

लेबल की सूची; ज़रूरी है

शेल स्क्रिप्ट वाली फ़ाइल.

यह एट्रिब्यूट एक सिंगलटन सूची होनी चाहिए, जिसका एलिमेंट शेल स्क्रिप्ट है. यह स्क्रिप्ट एक्ज़ीक्यूटेबल होनी चाहिए. साथ ही, यह कोई सोर्स फ़ाइल या जनरेट की गई फ़ाइल हो सकती है. रनटाइम के दौरान ज़रूरी अन्य सभी फ़ाइलें (चाहे स्क्रिप्ट हों या डेटा), data एट्रिब्यूट में शामिल होती हैं.