From 8f76f04ff39c1aa699b4cf070f437d4564488b8b Mon Sep 17 00:00:00 2001 From: dktran65g Date: Wed, 8 Apr 2026 18:59:41 -0400 Subject: [PATCH] Add README for socket-bazel-adapter Added documentation for socket-bazel-adapter including features and quick start instructions. --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6a8a886 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# socket-bazel-adapter + +A vendor auxiliary adapter that wraps the [Socket CLI](https://docs.socket.dev/cli) for use within Bazel build environments. Drop the `socket-tool/` folder into any Bazel monorepo to run Socket security scans (standard or Tier-1 reachability analysis) against collected manifest and lockfiles. + +## What it does + +- Generates missing manifest files from orphaned lockfiles +- Collects manifest files into a `bazel-manifest-output/` directory +- Runs Socket security scans via Bazel targets (`socket_scan` or `t1_socket_scan`) + +## Quick start + +See [HOW-TO-use-socket-tool-in-Bazel.md](HOW-TO-use-socket-tool-in-Bazel.md) for setup, environment variables, and usage instructions. + +## Example + +Reference project: [monorepo-bazel-demo](https://github.com/socketdev-demo/monorepo-bazel-demo)