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
File details
Details for the file mozilla_nimbus_schemas-2024.11.4.tar.gz.
File metadata
- Download URL: mozilla_nimbus_schemas-2024.11.4.tar.gz
- Upload date:
- Size: 31.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d8683600f63ed99a900984033363f8e23326b7b3bc5579c7538aad960fcfcd13 |
|
| MD5 | e62a541c32033c0e480163142b1cad8e |
|
| BLAKE2b-256 | 2345fd131409073766f7a6a34d65a9ef68729d7d6be8c8200aea9848df6566f9 |
File details
Details for the file mozilla_nimbus_schemas-2024.11.4-py3-none-any.whl.
File metadata
- Download URL: mozilla_nimbus_schemas-2024.11.4-py3-none-any.whl
- Upload date:
- Size: 54.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 97d6c1d2ab8e1da13ffd62651b93d2adf2985a98e2efb8d70acadfe24beb976f |
|
| MD5 | 0d0dff032bb5159e4de22ed2fddd1ae8 |
|
| BLAKE2b-256 | 5205992c22b6825c500ab57c73c18a7e1594b7dc6a301f6efb6d5c4f646e5553 |
