Aturan Shell

Nightly · 9.1 · 9.0 · 8.7 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 8.1

Aturan

sh_binary

Lihat sumber aturan 
sh_binary(name, deps, srcs, data, args, aspect_hints, compatible_with, deprecation, env, env_inherit, exec_compatible_with, exec_group_compatible_with, exec_properties, features, output_licenses, package_metadata, restricted_to, tags, target_compatible_with, testonly, toolchains, use_bash_launcher, visibility)

Aturan sh_binary digunakan untuk mendeklarasikan skrip shell yang dapat dieksekusi. (sh_binary adalah nama yang kurang tepat: outputnya tidak selalu berupa biner.) Aturan ini memastikan bahwa semua dependensi dibuat, dan muncul di area runfiles pada waktu eksekusi. Sebaiknya beri nama aturan sh_binary() sesuai dengan nama skrip tanpa ekstensi (misalnya, .sh); nama aturan dan nama file harus berbeda. sh_binary menghormati shebang, sehingga interpreter apa pun yang tersedia dapat digunakan (mis. #!/bin/zsh)

Contoh

Untuk skrip shell sederhana tanpa dependensi dan beberapa file data: 

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

Argumen

Atribut
name

Nama; wajib

Nama unik untuk target ini.
deps

Daftar label; default-nya adalah []

Daftar target "library" yang akan diagregasi ke dalam target ini. Lihat komentar umum tentang deps di Atribut umum yang ditentukan oleh sebagian besar aturan build.

Atribut ini harus digunakan untuk mencantumkan aturan sh_library lain yang menyediakan kode sumber program yang diinterpretasikan yang bergantung pada kode di srcs. File yang disediakan oleh aturan ini akan ada di antara runfiles target ini.

srcs

Daftar label; default-nya adalah []

File yang berisi skrip shell.

Atribut ini harus berupa daftar singleton, yang elemennya adalah skrip shell. Skrip ini harus dapat dieksekusi, dan dapat berupa file sumber atau file yang dihasilkan. Semua file lain yang diperlukan saat runtime (baik skrip maupun data) berada dalam the data atribut.

env_inherit

Daftar string; default-nya adalah []
use_bash_launcher

Boolean; default-nya adalah False

Menggunakan peluncur bash yang menginisialisasi library runfiles

sh_library

Lihat sumber aturan 
sh_library(name, deps, srcs, data, aspect_hints, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, package_metadata, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

Penggunaan utama aturan ini adalah untuk mengagregasi "library" logis yang terdiri dari skrip terkait—program dalam bahasa yang diinterpretasikan yang tidak memerlukan kompilasi atau penautan, seperti shell Bourne—dan data apa pun yang diperlukan program tersebut saat runtime. "Library" tersebut kemudian dapat digunakan dari atribut data dari satu atau lebih sh_binary aturan.

Anda dapat menggunakan aturan filegroup untuk mengagregasi file data.

Dalam bahasa pemrograman yang diinterpretasikan, tidak selalu ada perbedaan yang jelas antara "kode" dan "data": bagaimanapun, program hanyalah "data" dari sudut pandang interpreter. Oleh karena itu, aturan ini memiliki tiga atribut yang pada dasarnya setara: srcs, deps, dan data. Implementasi saat ini tidak membedakan antara elemen daftar ini. Ketiga atribut menerima aturan, file sumber, dan file yang dihasilkan. Namun, sebaiknya gunakan atribut untuk tujuan biasanya (seperti aturan lainnya).

Contoh

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

Argumen

Atribut
name

Nama; wajib

Nama unik untuk target ini.
deps

Daftar label; default-nya adalah []

Daftar target "library" yang akan diagregasi ke dalam target ini. Lihat komentar umum tentang deps di Atribut umum yang ditentukan oleh sebagian besar aturan build.

Atribut ini harus digunakan untuk mencantumkan aturan sh_library lain yang menyediakan kode sumber program yang diinterpretasikan yang bergantung pada kode di srcs. File yang disediakan oleh aturan ini akan ada di antara runfiles target ini.

srcs

Daftar label; default-nya adalah []

Daftar file input.

Atribut ini harus digunakan untuk mencantumkan file sumber skrip shell yang termasuk dalam library ini. Skrip dapat memuat skrip lain menggunakan perintah source atau . shell.

sh_test

Lihat sumber aturan 
sh_test(name, deps, srcs, data, args, aspect_hints, compatible_with, deprecation, env, env_inherit, exec_compatible_with, exec_group_compatible_with, exec_properties, features, flaky, local, package_metadata, restricted_to, shard_count, size, tags, target_compatible_with, testonly, timeout, toolchains, use_bash_launcher, visibility)

Aturan sh_test() membuat pengujian yang ditulis sebagai skrip shell Bourne.

Lihat atribut umum untuk semua aturan pengujian (*_test).

Contoh

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

Argumen

Atribut
name

Nama; wajib

Nama unik untuk target ini.
deps

Daftar label; default-nya adalah []

Daftar target "library" yang akan diagregasi ke dalam target ini. Lihat komentar umum tentang deps di Atribut umum yang ditentukan oleh sebagian besar aturan build.

Atribut ini harus digunakan untuk mencantumkan aturan sh_library lain yang menyediakan kode sumber program yang diinterpretasikan yang bergantung pada kode di srcs. File yang disediakan oleh aturan ini akan ada di antara runfiles target ini.

srcs

Daftar label; default-nya adalah []

File yang berisi skrip shell.

Atribut ini harus berupa daftar singleton, yang elemennya adalah skrip shell. Skrip ini harus dapat dieksekusi, dan dapat berupa file sumber atau file yang dihasilkan. Semua file lain yang diperlukan saat runtime (baik skrip maupun data) berada dalam the data atribut.

use_bash_launcher

Boolean; default-nya adalah False

Menggunakan peluncur bash yang menginisialisasi library runfiles