Skip to content

workflow-bazel.md

Latest commit

 

History

History
60 lines (38 loc) · 2.57 KB

workflow-bazel.md

File metadata and controls

60 lines (38 loc) · 2.57 KB

Valdi rules for Bazel

Each valdi module contains a BUILD.bazel file which has a single call to valdi_module macros. The macro setups a few targets and aliases to build the module from source using the Valdi Toolchain.

The list of targets created by the valdi_module macro includes:

  • module_name:module_name target which builds just the .valdimodule file. It is the default target and can be referenced as module_name for example //src/valdi_modules/src/valdi/jasmine.
  • module_name:module_name_kt target which builds the android_library and packages the Valdi generated Kotlin code, if any. It depends on the Valdi module target above and adds the .valdimodule and other resources to the data attribute.
  • module_name:module_name_objc target which builds the objc_library and packages the Valdi generated Objective-C code, if any. It depends on the Valdi module target above and adds the .valdimodule and other resources to the data attribute.
  • module_name:module_name_objc_api target which builds the objc_library and wraps the generated Objective-C API code, if any. It also depends on the module_name_objc target above.
  • module_name:{ModuleName} an alias pointing at module_name:module_name_objc to keep the compatibility with iOS
  • module_name:{ModuleName}Types an alias pointing at module_name:module_name_objc_api to keep the compatibility with iOS

Building

To build a single module using the default, macOS toolchain:

bazel build //src/valdi_modules/src/valdi/jasmine

Android

To build the Android target:

bazel build //src/valdi_modules/src/valdi/jasmine --platforms=@snap_platforms//os:android_arm64

iOS

To build the iOS target:

bazel build //src/valdi_modules/src/valdi/jasmine --platforms=//bzl/platforms:ios_x64

Maintaining BUILD.bazel files

To ease the burden of writing and maintainting BUILD.bazel Valdi provides a script to automatically generate/update/format BUILD.bazel files based on module.yaml content. In addition to that, the CI infrastructure includes a pre-cool hook to validate BUILD.bazel files.

To add a new dependency:

  1. Update module.yaml
  2. Run the script:
./scripts/regenerate_valdi_modules_build_bazel_files.sh

Testing

You can run your tests using bazel test directly. See documentation about it here: Testing.

Linting

Once implemented, users will be able to run linting for a single module using Bazel.

Known issues and limitations

  • Updating proto config doesn't trigger a valdi module rebuild