tree: 17c7d4204ad6805400cb720c08e00da5645277af [path history] [tgz]
  1. golden/
  2. src/
  3. banjo_library.json
  4. bind_library.json
  5. BUILD.gn
  6. cc_prebuilt_library.json
  7. cc_source_library.json
  8. common.json
  9. companion_host_tool.json
  10. dart_library.json
  11. data.json
  12. documentation.json
  13. emu_manifest.json
  14. fidl_library.json
  15. flash_manifest-835e8f26.json
  16. hardware-f6f47515.json
  17. host_tool.json
  18. loadable_module.json
  19. manifest.json
  20. physical_device-0bd5d21f.json
  21. product_bundle-6320eef1.json
  22. product_bundle_container-32z5e391.json
  23. product_bundle_container-76a5c104.json
  24. product_bundle_container.go
  25. product_bundle_container_test.go
  26. README.md
  27. sysroot.json
  28. version.gni
  29. version_history-038fa854.json
  30. version_history-ef02ef45.json
  31. virtual_device-93A41932.json
build/sdk/meta/README.md

SDK metadata schemas

This directory contains JSON schemas for metadata files added to SDKs. These schemas are included in SDKs under //meta/schemas.

New schemas may only be added if given express permission from sdk-dev@fuchsia.dev. New schemas must be added to the schema list in BUILD.gn to ensure future compatibility. Thus, a corresponding golden file for each new schema needs to be created under /golden.

Versioning

In order to help consumers of the SDK adjust to metadata changes, each SDK embeds an opaque version number for its metadata schema. This version number is specified in version.gni and can be found in SDKs in //meta/manifest.json.

Changes to schemas that require some consumer action should be accompanied by an increment of this version number. Such changes include:

  • adding a new property;
  • changing a property from required to optional;
  • renaming a property;
  • changing a property's type;
  • adding a schema for a new SDK element type.

Testing

Run unit tests with:

fx test host_x64/sdk_metadata_lib_test