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
5 changes: 5 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ on:
- "mkdocs.yml"
- "pyproject.toml"
- "scripts/validate_docs.py"
- "scripts/generate_api_reference.py"
- "tests/validate.sh"
- ".github/workflows/docs.yml"
pull_request:
Expand All @@ -21,6 +22,7 @@ on:
- "mkdocs.yml"
- "pyproject.toml"
- "scripts/validate_docs.py"
- "scripts/generate_api_reference.py"
- "tests/validate.sh"
- ".github/workflows/docs.yml"
workflow_dispatch:
Expand Down Expand Up @@ -52,6 +54,9 @@ jobs:
- name: Validate repository links and examples
run: python scripts/validate_docs.py

- name: Validate generated public API reference
run: python scripts/generate_api_reference.py --check

- name: Build documentation with strict warnings
run: python -m mkdocs build --strict --site-dir site

Expand Down
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ and versions are tracked in the repo-root `VERSION` file.
production-lifecycle positioning for Click and Typer adopters.
- Add deterministic SPDX SBOMs, artifact checksums, and OIDC-backed GitHub
attestations to protected release workflows.
- Add a generated public API reference and a strict CI drift check so every
stable facade export remains searchable and documented.

### Changed

Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,8 @@ The supported public facade, compatibility promises, deprecation warning
mechanism, and migration requirements are documented in
[`docs/api-stability.md`](https://basefoundry.github.io/base-cli/api-stability/) and
[`docs/migrations.md`](https://basefoundry.github.io/base-cli/migrations/).
The complete generated facade is listed in the
[`public API reference`](https://basefoundry.github.io/base-cli/api-reference/).

Security reporting, runtime trust boundaries, threat assumptions, and the
release security checklist are documented in [`SECURITY.md`](SECURITY.md),
Expand Down
Loading
Loading