Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 1.57 KB

README.md

File metadata and controls

46 lines (32 loc) · 1.57 KB
Raw

WARNING

This is purely experimental, provides an unstable API, and has zero commitment to backwards compatibility. Documentation may also be stale.

Testing

GitHub Actions

Tested on CI:

  • Basic Bazel functionality, command-line expectations.

Not Tested on CI:

  • Girder Backend
  • Lint

For Consumers of external_data

The main file of interest is:

  • external_data.bzl - Macros for using external data.
  • cli - (To be added) Command-line interface.

For Developers of external_data

This presently performs meta-testing with Bazel to ensure that we achieve the desired workflows with Bazel. This is all structured such that bazel test ... is valid from Drake, and from each test workspace under test/.

Main structure:

  • BUILD.bazel - Effectively a no-op; only for exposing files.
  • expose_all_files.bzl - Macros to allow for (recursive) consumption of files from separate packages / workspaces.
  • bazel_external_data/ - Python code for CLI interface (for both end users and Bazel genrules).
  • test/
    • BUILD.bazel - Declares tests (unlike other Drake packages), declares linting for all of //....
    • external_data_workspace_tests.bzl - Provides a list of workspaces to be tested, repository declarations, convenience wrappings for linting files, and macro for external_data_workspace_test.sh.
    • external_data_*_test - Workspaces for testing downstream behavior.
      • external_data_pkg_test - Stub for now.