aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 21 insertions, 7 deletions
diff --git a/README.md b/README.md
index d4ce9e8..1527f74 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,27 @@
# rules_license
+CI: [![Build status](https://badge.buildkite.com/e12f23186aa579f1e20fcb612a22cd799239c3134bc38e1aff.svg)](https://buildkite.com/bazel/rules-license)
+
This repository contains a set of rules and tools for
-- asserting that packages are available under specified OSS licenses
-- gathering those license assertions into artifacts to ship with code
+- declaring metadata about packages, such as
+ - the licenses the package is available under
+ - the canonical package name and version
+ - copyright information
+ - ... and more TBD in the future
+- gathering those license declarations into artifacts to ship with code
- applying organization specific compliance constriants against the
- set of licenses used by a target.
+ set of packages used by a target.
+- (eventually) producing SBOMs for built artifacts.
+
+WARNING: The code here is still in active initial development and will churn a lot.
-See [License Checking with
-Bazel](https://docs.google.com/document/d/1uwBuhAoBNrw8tmFs-NxlssI6VRolidGYdYqagLqHWt8/edit#)
-for more information about the project.
+If you want to follow along:
+- Mailing list: [bazel-ssc@bazel.build](https://groups.google.com/a/bazel.build/g/bazel-ssc)
+- Monthly eng meeting: [calendar link](MjAyMjA4MjJUMTYwMDAwWiBjXzUzcHBwZzFudWthZXRmb3E5NzhxaXViNmxzQGc&tmsrc=c_53pppg1nukaetfoq978qiub6ls%40group.calendar.google.com&scp=ALL)
+- [Latest docs](https://bazelbuild.github.io/rules_license/latest.html)
-WARNING: The code here is still in active initial development and may be under churn.
+Background reading:
+These is for learning about the problem space, and our approach to solutions. Concrete specifications will always appear in checked in code rather than documents.
+- [License Checking with Bazel](https://docs.google.com/document/d/1uwBuhAoBNrw8tmFs-NxlssI6VRolidGYdYqagLqHWt8/edit#).
+- [OSS Licenses and Bazel Dependency Management](https://docs.google.com/document/d/1oY53dQ0pOPEbEvIvQ3TvHcFKClkimlF9AtN89EPiVJU/edit#)
+- [Adding OSS license declarations to Bazel](https://docs.google.com/document/d/1XszGbpMYNHk_FGRxKJ9IXW10KxMPdQpF5wWbZFpA4C8/edit#heading=h.5mcn15i0e1ch)