lee/bottom

mirror of https://github.com/ClementTsang/bottom.git synced 2026-05-03 13:30:44 +00:00

Files

T

Clement Tsang 8da4a84ea8 other: update changelog and deployment release template (#1917 )

* other: update changelog and deployment release template

* also update pr example for schemastore

2025-12-25 01:07:30 -05:00

1.1 KiB

Raw Permalink Blame History

Config JSON Schema

Generation

These are automatically generated from code using schemars. They're locked behind a feature flag to avoid building unnecessary code for release builds, and you can generate them like so:

# Will print out to stdout
cargo run --features="generate_schema" -- --generate_schema

# e.g. for nightly
cargo run --features="generate_schema" -- --generate_schema > schema/nightly/bottom.json

# e.g. for a specific version
cargo run --features="generate_schema" -- --generate_schema 0.12.0 > schema/v0.12.0/bottom.json

Alternatively, run the scripts/schema/generate.sh script (for stable releases) or scripts/schema/nightly.sh (for nightly), which does all of this for you.

Publication

To publish these schemas:

Stable

Run scripts/schema/generate.sh <YOUR_VERSION>.
Make a PR and merge it.
Then, make a PR to schemastore to update the catalog. Here's an example of a PR.

Nightly

Run scripts/schema/nightly.sh.
Make a PR and merge it.

1.1 KiB Raw Permalink Blame History