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.11
- poetry ^1.2.2
- 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
VERSION
file 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.
Project details
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.3.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 184d9e3e23d18975339fd6b467f7172d98d6e8fd3bedda203af531d81036c897 |
|
MD5 | 7e3891003ea505a030f72a9c8f156cb1 |
|
BLAKE2b-256 | 43e0bdb69b8a074a5f82c1cfa7bcc530005b6ca9884ad81d2b9a1096a0b2b419 |
Hashes for mozilla_nimbus_schemas-2024.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 848bb2332bf637ac4b565a86468f72de50309b1ee254fe2acf45028feae58bf9 |
|
MD5 | 88199bb962cf42b11f58b928a79903e8 |
|
BLAKE2b-256 | 0c7b77fa35d4e211ed63fa6d2ead358013aa5e4b1b34f495c4a487f5ec60e1c3 |