https://github.com/robotlocomotion/bazel-external-data

Handle external large files for use with Bazel.
https://github.com/robotlocomotion/bazel-external-data

Last synced: 7 months ago
JSON representation

Handle external large files for use with Bazel.

• Host: GitHub
• URL: https://github.com/robotlocomotion/bazel-external-data
• Owner: RobotLocomotion
• License: bsd-3-clause
• Created: 2017-12-19T20:00:05.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2025-03-28T14:49:08.000Z (9 months ago)
• Last Synced: 2025-03-31T16:13:41.089Z (9 months ago)
• Language: Python
• Size: 181 KB
• Stars: 2
• Watchers: 32
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# **WARNING**

**This is purely experimental, provides an unstable API, and has

zero commitment to backwards compatibility. Documentation may also be stale.**

# Testing

![GitHub Actions](https://img.shields.io/github/workflow/status/RobotLocomotion/bazel-external-data/ci/master)

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 `genrule`s).

*   `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.