Skip to content

docs: complete error-codes.md (46 -> 66 codes) + enforce enum-doc sync#490

Merged
padak merged 1 commit into
mainfrom
docs/error-codes-complete
Jul 20, 2026
Merged

docs: complete error-codes.md (46 -> 66 codes) + enforce enum-doc sync#490
padak merged 1 commit into
mainfrom
docs/error-codes-complete

Conversation

@padak

@padak padak commented Jul 20, 2026

Copy link
Copy Markdown
Member

Why

docs/error-codes.md had drifted 20 codes behind the ErrorCode enum (46 documented vs 66 members) — everything added since ~0.22.0 was missing: Data Apps, Developer Portal, Flow, the kbagent serve envelope codes, and the newer Sync/Auth codes. The doc is now publicly linked from the new help-docs CLI section (keboola/connection-docs#1015), so an incomplete list ships broken public documentation.

What

  • docs/error-codes.md: adds the 20 missing codes to their category sections; new sections Flow, Data Apps, Developer Portal. Descriptions were written from the actual emit sites, not guessed. DATA_APP_INVALID_REPO and DATA_APP_REPO_VALIDATION_BLOCKING are honestly marked reserved — defined in the enum since 0.28.0 but not emitted anywhere (validate-repo signals findings via exit 1).
  • scripts/check_error_codes.py (make check-error-codes): new enum-vs-doc completeness check — every ErrorCode member must appear in the doc's tables and vice versa, so the doc cannot silently drift again. --list now reuses the shared enum parser.
  • Tests: TestErrorCodesDocCompleteness in tests/test_integration.py — doc matches enum; a pruned code and a planted stale row are both detected.

Verification

  • uv run python scripts/check_error_codes.pyOK: no raw error_code literals; docs/error-codes.md matches the enum.
  • uv run pytest tests/test_integration.py -q → 6 passed, 3 skipped (env-gated)
  • ruff check + ruff format --check clean

No version bump: docs + local-only CI guard, no runtime behavior change.


Open in Devin Review

…c in check-error-codes

docs/error-codes.md had drifted 20 codes behind the ErrorCode enum (missing
all Data Apps, Developer Portal, Flow, serve-envelope, and newer Sync/Auth
codes). The doc is publicly linked from the new help-docs CLI section
(keboola/connection-docs#1015), so completeness now matters.

- Add the 20 missing codes to their category sections; new sections: Flow,
  Data Apps, Developer Portal. DATA_APP_INVALID_REPO and
  DATA_APP_REPO_VALIDATION_BLOCKING are marked reserved (defined in the enum
  since 0.28.0 but not currently emitted; validate-repo signals via exit 1).
- Extend scripts/check_error_codes.py (make check-error-codes) with an
  enum-vs-doc completeness check: every ErrorCode member must appear in the
  doc and vice versa, so the doc cannot silently drift again. --list now
  reuses the shared enum parser.
- Tests: TestErrorCodesDocCompleteness in tests/test_integration.py (doc
  matches enum; missing-code and stale-code drift both detected).

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@padak
padak merged commit 5fadc2a into main Jul 20, 2026
5 checks passed
@padak
padak deleted the docs/error-codes-complete branch July 20, 2026 11:02
Iamfle4ka pushed a commit to keboola/connection-docs that referenced this pull request Jul 20, 2026
…eenshot

agent create gets required --cli claude; agent test (ad-hoc only) replaced
with agent run <task-id>; agent runs takes the task ID; result notes that
scheduled firing needs kbagent serve running. Error-codes paragraph drops
the category count too (17 incoming via keboola/cli#490).

Adds the interactive lineage-browser screenshot (demo-project pipeline:
extractor tables -> two transformations -> BDM outputs) to the lineage
reference bullet.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
padak added a commit that referenced this pull request Jul 20, 2026
Backfills changelog entries for ten PRs merged since v0.66.1 without a
version bump (#465 #486 #487 #488 #490 #492 #493 #494 #495 + #500),
attributed to their bump windows (0.67.0 / 0.70.0 / 0.70.1 / 0.71.0),
and aligns the version at 0.71.0 as the catch-up release: 0.67.0-0.70.1
were merged to main but never tagged or published, so auto-update users
are still on 0.66.1. The v0.71.0 tag + GitHub Release follow.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant