Skip to content

Commit ba5b4fb

Browse files
mvicknrclaude
andcommitted
fix: Update readme to fix formatting issues
Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 46b4679 commit ba5b4fb

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

.fleetControl/schemaGeneration/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This directory contains the Python scripts that walk
88
## Files
99

1010
| File | Description |
11-
|------|-------------|
11+
| --- | --- |
1212
| `generate-schema.py` | Per-push regenerator. Reads the live agent settings tree, writes `config.json`. Never touches `configurationDefinitions.yml`. |
1313
| `bump-schema-version.py` | Release-time version bumper. Compares the schema at a prior git ref to the current schema and writes a new version into `configurationDefinitions.yml`. |
1414
| `schema_diff.py` | Shared library (no `main`). Holds the diff classification (`classify_changes`), bump arithmetic (`recommend_bump`, `apply_bump`, `bump_version`), and schema loading (`load_existing`). Imported by both top-level scripts. |
@@ -229,13 +229,13 @@ The `.*` suffix matches both the prefix itself and any descendant.
229229
### Generator CLI (`generate-schema.py`)
230230

231231
| Option | Description |
232-
|--------|-------------|
232+
| --- | --- |
233233
| `--force` | Overwrite the schema without comparing to the existing one. Always exits 0. |
234234

235235
### Bumper CLI (`bump-schema-version.py`)
236236

237237
| Option | Description |
238-
|--------|-------------|
238+
| --- | --- |
239239
| `--since=<ref>` | Required. Compare the current schema to the schema at `<ref>` and recommend a bump. |
240240
| `--ci` | Write the bumped version to `configurationDefinitions.yml`. Without this, the script just prints the recommendation. |
241241

@@ -244,15 +244,15 @@ The `.*` suffix matches both the prefix itself and any descendant.
244244
### Generator exit codes (`generate-schema.py`)
245245

246246
| Code | Meaning |
247-
|------|---------|
247+
| --- | --- |
248248
| 0 | No schema changes (or first run, or `--force` mode). |
249249
| 1 | Schema regenerated and on-disk differed (CI should commit). |
250250
| 2 | Generator failure (invalid schema, malformed inputs). |
251251

252252
### Bumper exit codes (`bump-schema-version.py`)
253253

254254
| Code | Meaning |
255-
|------|---------|
255+
| --- | --- |
256256
| 0 | No bump needed (no schema diff, or bootstrap case where `<ref>` predates the schema). |
257257
| 1 | Bump applied (`--ci`) or recommended (without `--ci`). |
258258
| 2 | Bump failure (uncaught exception, missing args, malformed historical inputs). |
@@ -263,7 +263,7 @@ The `.*` suffix matches both the prefix itself and any descendant.
263263
kind is the highest severity across all changes:
264264

265265
| Change type | Severity | Bump |
266-
|-------------|----------|------|
266+
| --- | --- | --- |
267267
| Property removed | Breaking | Major |
268268
| Type changed | Breaking | Major |
269269
| Enum value removed | Breaking | Major |

0 commit comments

Comments
 (0)