Schemas used by Mozilla Nimbus and related projects.
Project description
Nimbus Schemas
This directory contains a package of schemas published to various repositories for use by different parts of the Mozilla Nimbus experimentation ecosystem.
Installation/Usage
Prerequisites
- python ^3.10
- poetry ^1.8.4
- node ^16
- yarn ^1.22
Common Operations
From project root (i.e., parent to this directory)
- Build:
make schemas_build - Run linting and tests:
make schemas_check - Code formatting:
make schemas_format
Building Python Schemas Package
make schemas_build_pypi
Building Typescript Schemas Package
make schemas_build_npm
Schemas
Jetstream
Contains schemas describing analysis results, metadata, and errors from Jetstream.
Deployment
The build and deployment occurs automatically through CI. A deployment is triggered on merges into the main branch when the version number changes. Schemas are published to various repos for access in different languages.
Versioning
mozilla-nimbus-schemas uses a date-based versioning scheme (CalVer). The format is yyyy.m.MINOR, where m is the non-zero-padded month, and MINOR is an incrementing number starting from 1 for each month. Notably, this MINOR number does NOT correspond to the day of the month. For example, the second release in June of 2023 would have a version of 2023.6.2.
Version Updates
- To update the published package versions, update the
VERSIONfile in this directory.
- From the project root, you can run the helper script:
./scripts/set_schemas_version.sh <version>
- Or write to the file:
echo <version> > ./schemas/VERSION
- Or simply edit the file in any text editor.
- Update the package versions with the new VERSION file:
make schemas_version
Python
Published to PyPI as mozilla-nimbus-schemas
Typescript
Published to NPM as @mozilla/nimbus-schemas
Rust
Not yet implemented.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mozilla_nimbus_schemas-2024.11.3.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f6cb9bafb43886ef8b36a589fa9027b28890e6453c0337eac2b5f558255010d4 |
|
| MD5 | 8aecaeaa89192e55cdbf542288f5e1fd |
|
| BLAKE2b-256 | 36c89cb95ec888b5cba89f0f9f2c45502ea6b357310232ecdc100061c2bbc0eb |
Hashes for mozilla_nimbus_schemas-2024.11.3-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 999087c92c69a38f9df40b88cdb6bff50b8f6241b7d009e0343d51bf79d6e7f7 |
|
| MD5 | cadce726d16975b4469dbad878ef8edb |
|
| BLAKE2b-256 | bc2e4503fc5d990a785f5edd84f4a6603ce09217ec1e47ecf8be6de6c7779367 |
