Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/cli-consistency.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ on:
# sdk-and-plugins as much as in the command reference. A narrower filter
# means a PR can add a broken invocation and never run this job.
- 'docs/**'
# The repo-root README is a docs surface too, and it is the one GitHub
# shows first. It is now swept for version claims, so a change to it must
# run this job.
- 'README.md'
- 'scripts/check_cli_docs.py'
- 'scripts/check_providers.py'
- 'scripts/cli-docs-allowlist.yml'
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Fluid Forge is a contract-first CLI for building, validating, and deploying data

## Current Versioning

- Current CLI release documented here: `0.8.11`
- Current scaffolded contract schema examples: `fluidVersion: 0.7.4`
- Current CLI release documented here: `0.15.0`
- Current scaffolded contract schema examples: `fluidVersion: 0.7.5`

Those are different on purpose. `fluid version` reports the installed CLI release, while `fluidVersion` inside a contract selects the contract schema version.

Expand Down
13 changes: 12 additions & 1 deletion scripts/check_cli_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,14 @@ def _iter_doc_files(root: Path) -> list[Path]:
if _SKIP_DIR_PARTS & set(path.relative_to(root).parts):
continue
out.append(path)
# The repo-root README is a docs surface with the widest audience of all -
# it is what GitHub shows first - but it lives outside docs/, so the sweep
# never saw it. It sat seven releases stale (0.8.11 against a 0.15.0 pin)
# while every in-tree page was green.
if root == DOCS_DIR:
root_readme = REPO_ROOT / "README.md"
if root_readme.is_file():
out.append(root_readme)
return out


Expand Down Expand Up @@ -831,7 +839,10 @@ def check_doc_flags(allowlist: set[str]) -> int:
),
(
"CLI release bullet",
re.compile(r"(?i)^\s*[-*]\s*CLI\s+release\s*" + _V),
# Tolerates words between "CLI release" and the version - the repo-root
# README writes "Current CLI release documented here: `x.y.z`", which the
# tighter form missed, letting it sit seven releases stale.
re.compile(r"(?i)^\s*[-*]\s*(?:current\s+)?CLI\s+release\b[^.\n]{0,32}?" + _V),
"cli",
),
(
Expand Down