Conversation
There was a problem hiding this comment.
Pull request overview
This PR introduces a configurable WorkbenchLabels contract and threads it through OperatorAppSpec into the shared Workbench widget, so operator-facing “chrome” text (panel titles, summary text, default key/value column headers) can be customized instead of being hardcoded. It also adds a typing marker (py.typed), updates docs, and expands smoke tests to cover the new behavior and stricter widget enforcement for pages.
Changes:
- Add
WorkbenchLabelsto contracts and export it, then addOperatorAppSpec.workbench_labelsand pass it intoWorkbench. - Replace several hardcoded workbench strings with
WorkbenchLabelsvalues and adjust context-table column handling. - Add smoke tests and documentation describing how to override workbench chrome labels; add
py.typedmarker.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_app_smoke.py | Adds coverage for rejecting non-Widget pages and for overriding workbench chrome labels/columns. |
| src/groundskeeping/widgets/workbench.py | Accepts WorkbenchLabels, uses it for panel titles/summary and default key/value columns. |
| src/groundskeeping/py.typed | Marks the package as typed (PEP 561). |
| src/groundskeeping/contracts/views.py | Introduces the WorkbenchLabels dataclass. |
| src/groundskeeping/contracts/init.py | Re-exports WorkbenchLabels from the contracts package. |
| src/groundskeeping/app.py | Adds workbench_labels to OperatorAppSpec and wires it into Workbench; centralizes widget validation. |
| README.md | Documents workbench_labels usage at a high level. |
| docs/pages.md | Adds guidance on when to use workbench_labels vs page-owned titles. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
removing hardcoded labels where they appear in the app, plus some typing updates
Checklist
breaking,feature,fix,dependencies, orchore)uv run pytest -q)uv run ruff check .)