experimenter/schemas
dependabot[bot] 39960485ef
chore(deps-dev): Bump black from 23.11.0 to 23.12.0 in /schemas (#9960)
Bumps [black](https://github.com/psf/black) from 23.11.0 to 23.12.0.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/psf/black/releases">black's
releases</a>.</em></p>
<blockquote>
<h2>23.12.0</h2>
<h3>Highlights</h3>
<p>It's almost 2024, which means it's time for a new edition of
<em>Black</em>'s stable style!
Together with this release, we'll put out an alpha release 24.1a1
showcasing the draft
2024 stable style, which we'll finalize in the January release. Please
try it out and
<a href="https://redirect.github.com/psf/black/issues/4042">share your
feedback</a>.</p>
<p>This release (23.12.0) will still produce the 2023 style. Most but
not all of the
changes in <code>--preview</code> mode will be in the 2024 stable
style.</p>
<h3>Stable style</h3>
<ul>
<li>Fix bug where <code># fmt: off</code> automatically dedents when
used with the <code>--line-ranges</code>
option, even when it is not within the specified line range. (<a
href="https://redirect.github.com/psf/black/issues/4084">#4084</a>)</li>
<li>Fix feature detection for parenthesized context managers (<a
href="https://redirect.github.com/psf/black/issues/4104">#4104</a>)</li>
</ul>
<h3>Preview style</h3>
<ul>
<li>Prefer more equal signs before a break when splitting chained
assignments (<a
href="https://redirect.github.com/psf/black/issues/4010">#4010</a>)</li>
<li>Standalone form feed characters at the module level are no longer
removed (<a
href="https://redirect.github.com/psf/black/issues/4021">#4021</a>)</li>
<li>Additional cases of immediately nested tuples, lists, and
dictionaries are now
indented less (<a
href="https://redirect.github.com/psf/black/issues/4012">#4012</a>)</li>
<li>Allow empty lines at the beginning of all blocks, except immediately
before a
docstring (<a
href="https://redirect.github.com/psf/black/issues/4060">#4060</a>)</li>
<li>Fix crash in preview mode when using a short
<code>--line-length</code> (<a
href="https://redirect.github.com/psf/black/issues/4086">#4086</a>)</li>
<li>Keep suites consisting of only an ellipsis on their own lines if
they are not
functions or class definitions (<a
href="https://redirect.github.com/psf/black/issues/4066">#4066</a>) (<a
href="https://redirect.github.com/psf/black/issues/4103">#4103</a>)</li>
</ul>
<h3>Configuration</h3>
<ul>
<li><code>--line-ranges</code> now skips <em>Black</em>'s internal
stability check in <code>--safe</code> mode. This
avoids a crash on rare inputs that have many unformatted same-content
lines. (<a
href="https://redirect.github.com/psf/black/issues/4034">#4034</a>)</li>
</ul>
<h3>Packaging</h3>
<ul>
<li>Upgrade to mypy 1.7.1 (<a
href="https://redirect.github.com/psf/black/issues/4049">#4049</a>) (<a
href="https://redirect.github.com/psf/black/issues/4069">#4069</a>)</li>
<li>Faster compiled wheels are now available for CPython 3.12 (<a
href="https://redirect.github.com/psf/black/issues/4070">#4070</a>)</li>
</ul>
<h3>Integrations</h3>
<ul>
<li>Enable 3.12 CI (<a
href="https://redirect.github.com/psf/black/issues/4035">#4035</a>)</li>
<li>Build docker images in parallel (<a
href="https://redirect.github.com/psf/black/issues/4054">#4054</a>)</li>
<li>Build docker images with 3.12 (<a
href="https://redirect.github.com/psf/black/issues/4055">#4055</a>)</li>
</ul>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/psf/black/blob/main/CHANGES.md">black's
changelog</a>.</em></p>
<blockquote>
<h2>23.12.0</h2>
<h3>Highlights</h3>
<p>It's almost 2024, which means it's time for a new edition of
<em>Black</em>'s stable style!
Together with this release, we'll put out an alpha release 24.1a1
showcasing the draft
2024 stable style, which we'll finalize in the January release. Please
try it out and
<a href="https://redirect.github.com/psf/black/issues/4042">share your
feedback</a>.</p>
<p>This release (23.12.0) will still produce the 2023 style. Most but
not all of the
changes in <code>--preview</code> mode will be in the 2024 stable
style.</p>
<h3>Stable style</h3>
<ul>
<li>Fix bug where <code># fmt: off</code> automatically dedents when
used with the <code>--line-ranges</code>
option, even when it is not within the specified line range. (<a
href="https://redirect.github.com/psf/black/issues/4084">#4084</a>)</li>
<li>Fix feature detection for parenthesized context managers (<a
href="https://redirect.github.com/psf/black/issues/4104">#4104</a>)</li>
</ul>
<h3>Preview style</h3>
<ul>
<li>Prefer more equal signs before a break when splitting chained
assignments (<a
href="https://redirect.github.com/psf/black/issues/4010">#4010</a>)</li>
<li>Standalone form feed characters at the module level are no longer
removed (<a
href="https://redirect.github.com/psf/black/issues/4021">#4021</a>)</li>
<li>Additional cases of immediately nested tuples, lists, and
dictionaries are now
indented less (<a
href="https://redirect.github.com/psf/black/issues/4012">#4012</a>)</li>
<li>Allow empty lines at the beginning of all blocks, except immediately
before a
docstring (<a
href="https://redirect.github.com/psf/black/issues/4060">#4060</a>)</li>
<li>Fix crash in preview mode when using a short
<code>--line-length</code> (<a
href="https://redirect.github.com/psf/black/issues/4086">#4086</a>)</li>
<li>Keep suites consisting of only an ellipsis on their own lines if
they are not
functions or class definitions (<a
href="https://redirect.github.com/psf/black/issues/4066">#4066</a>) (<a
href="https://redirect.github.com/psf/black/issues/4103">#4103</a>)</li>
</ul>
<h3>Configuration</h3>
<ul>
<li><code>--line-ranges</code> now skips <em>Black</em>'s internal
stability check in <code>--safe</code> mode. This
avoids a crash on rare inputs that have many unformatted same-content
lines. (<a
href="https://redirect.github.com/psf/black/issues/4034">#4034</a>)</li>
</ul>
<h3>Packaging</h3>
<ul>
<li>Upgrade to mypy 1.7.1 (<a
href="https://redirect.github.com/psf/black/issues/4049">#4049</a>) (<a
href="https://redirect.github.com/psf/black/issues/4069">#4069</a>)</li>
<li>Faster compiled wheels are now available for CPython 3.12 (<a
href="https://redirect.github.com/psf/black/issues/4070">#4070</a>)</li>
</ul>
<h3>Integrations</h3>
<ul>
<li>Enable 3.12 CI (<a
href="https://redirect.github.com/psf/black/issues/4035">#4035</a>)</li>
<li>Build docker images in parallel (<a
href="https://redirect.github.com/psf/black/issues/4054">#4054</a>)</li>
<li>Build docker images with 3.12 (<a
href="https://redirect.github.com/psf/black/issues/4055">#4055</a>)</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="d9ad09a32b"><code>d9ad09a</code></a>
Prepare release 23.12.0 (<a
href="https://redirect.github.com/psf/black/issues/4105">#4105</a>)</li>
<li><a
href="ebd543c0ac"><code>ebd543c</code></a>
Fix feature detection for parenthesized context managers (<a
href="https://redirect.github.com/psf/black/issues/4104">#4104</a>)</li>
<li><a
href="eb7661f8ab"><code>eb7661f</code></a>
Fix another case where we format dummy implementation for
non-functions/class...</li>
<li><a
href="0c9899956d"><code>0c98999</code></a>
Fix path in test message (<a
href="https://redirect.github.com/psf/black/issues/4102">#4102</a>)</li>
<li><a
href="9aea9768cb"><code>9aea976</code></a>
Only use dummy implementation logic for functions and classes (<a
href="https://redirect.github.com/psf/black/issues/4066">#4066</a>)</li>
<li><a
href="67b23d7185"><code>67b23d7</code></a>
Bump actions/setup-python from 4 to 5 (<a
href="https://redirect.github.com/psf/black/issues/4101">#4101</a>)</li>
<li><a
href="ce28be2705"><code>ce28be2</code></a>
Add dedicated preview feature for East Asian Width (<a
href="https://redirect.github.com/psf/black/issues/4097">#4097</a>)</li>
<li><a
href="61b529b7d1"><code>61b529b</code></a>
Allow empty lines at beginning of blocks (again) (<a
href="https://redirect.github.com/psf/black/issues/4060">#4060</a>)</li>
<li><a
href="e7e122e9ff"><code>e7e122e</code></a>
docs: Move <code>fmt: off</code> docs (<a
href="https://redirect.github.com/psf/black/issues/4090">#4090</a>)</li>
<li><a
href="432d9050c3"><code>432d905</code></a>
docs: Unify option descriptions between <code>--help</code> and
<code>the_basics.md</code> (<a
href="https://redirect.github.com/psf/black/issues/4076">#4076</a>)</li>
<li>Additional commits viewable in <a
href="https://github.com/psf/black/compare/23.11.0...23.12.0">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=black&package-manager=pip&previous-version=23.11.0&new-version=23.12.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-12-19 16:02:59 +00:00
..
mozilla_nimbus_schemas bug(nimbus): Refactor FeatureManifest schema (#9598) 2023-10-17 17:17:28 +00:00
.dockerignore fix #9271 chore(project): dockerize schemas (#9616) 2023-10-24 20:30:55 +00:00
Dockerfile fix #9675 chore(project): lock Poetry to 1.6.0 (#9676) 2023-11-06 17:26:42 +00:00
LICENSE
README.md fix #9156 feat(schemas): typescript schema generation and npm publish (#9157) 2023-08-11 20:56:49 +00:00
VERSION fix #9271 chore(project): dockerize schemas (#9616) 2023-10-24 20:30:55 +00:00
index.d.ts bug(nimbus): Refactor FeatureManifest schema (#9598) 2023-10-17 17:17:28 +00:00
package.json fix #9271 chore(project): dockerize schemas (#9616) 2023-10-24 20:30:55 +00:00
poetry.lock chore(deps-dev): Bump black from 23.11.0 to 23.12.0 in /schemas (#9960) 2023-12-19 16:02:59 +00:00
pyproject.toml fix #9271 chore(project): dockerize schemas (#9616) 2023-10-24 20:30:55 +00:00
yarn.lock chore(deps-dev): Bump typescript from 5.2.2 to 5.3.2 in /schemas (#9788) 2023-11-20 21:59:24 +00:00

README.md

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.2.2
  • node ^16
  • yarn ^1.22

Common Operations

From project root (i.e., parent to this directory)

  • Install: make schemas_install
  • Run linting and tests: make schemas_check
  • Code formatting: make schemas_code_format

Building Python Schemas Package

make schemas_build

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

  1. 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.
  1. 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.