Skip to content

Add TDL-0004: error vs warning semantics and phase boundaries#3004

Merged
ronpal merged 12 commits into
mainfrom
tdl-0004
May 21, 2026
Merged

Add TDL-0004: error vs warning semantics and phase boundaries#3004
ronpal merged 12 commits into
mainfrom
tdl-0004

Conversation

@ronpal
Copy link
Copy Markdown
Contributor

@ronpal ronpal commented May 15, 2026

Summary

  • Adds TDL-0004 documenting the toolkit's error/warning model: commands run to completion and aggregate issues at the next phase boundary, with ToolkitError reserved for unrecoverable conditions that abort immediately.
  • Acknowledges the three parallel severity systems we have today (legacy tk_warnings.SeverityLevel, build v2 numeric InsightDefinition, dataio/logger.Severity) and the cognite.neat._toolkit_adapter mapping where the Error/Warning naming bug originates.
  • Defines what a phase boundary is per command and why mutation phases stay fail-fast.

Draft for review — the open naming question (WARNING/NOTICE/HINT vs alternatives) is still being settled with @magnus-schjolberg.

Bump

  • Patch
  • Skip

Related

  • CDF-27907 — terminology / visual language for build output
  • CDF-27968 — reclassify HIGH-severity warnings as collected errors (uses this TDL as the contract)

Document the goal of running commands to completion (collecting issues
at phase boundaries) versus aborting only on ToolkitErrors, which are
by definition unrecoverable. Covers the three coexisting severity
systems (legacy tk_warnings SeverityLevel, build v2 numeric
InsightDefinition, dataio Severity) and the NEAT adapter that
originates the Error/Warning naming mismatch in CDF-27907.

Related: CDF-27907, CDF-27968.
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

ronpal added 3 commits May 18, 2026 11:18
Add a "Grounding in ruff" section explaining what we adopt directly
(run-to-completion, stable rule codes, per-rule docs, user-driven
suppression), what we adapt (categorical severity instead of ruff's
binary model; ToolkitError because we have side effects), and a
ruff↔toolkit concept mapping. Add stable rule codes (TK001, etc.) to
the consequences list since they unlock non-breaking rename and
suppression.
Merge the in-progress opener with the prior content and trim. Three
categorical severities for configuration quality, ToolkitError as a
fourth category outside the severity system for technical exceptions.

Drops the standalone Goal section (folded into What), the long
Grounding-in-ruff appendix (reduced to a single Why bullet), and
condenses Why and Consequences. Replaces NOTICE / HINT with just
HINT — walking through real classes showed every NOTICE candidate has
the same author rule as HINT (advisory / recommendation), so the
middle bucket carried no distinct signal.
@ronpal ronpal marked this pull request as ready for review May 19, 2026 09:14
@ronpal ronpal requested review from a team as code owners May 19, 2026 09:14
ronpal added 6 commits May 19, 2026 11:14
…cy check

The CDF API returns `subagents: []` on every AgentResponse even though
the field is not in the spec and local YAMLs never define it. Add
`subagents` to the existing list of undocumented empty fields that are
stripped from the CDF dump when absent in the local config, matching
the same handling already in place for `labels`, `exampleQuestions`,
and `skills`.
@github-actions
Copy link
Copy Markdown

ghost commented May 19, 2026

☂️ Code Coverage

current status: ✅

Overall Coverage

Statements Covered Coverage Threshold Status
43047 36989 86% 80% 🟢

New Files

No new covered files...

Modified Files

No covered modified files...

updated for commit: 08c9ab4 by action🐍

@codecov
Copy link
Copy Markdown

codecov Bot commented May 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.92%. Comparing base (342b47d) to head (08c9ab4).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3004   +/-   ##
=======================================
  Coverage   85.92%   85.92%           
=======================================
  Files         469      469           
  Lines       43047    43047           
=======================================
+ Hits        36986    36989    +3     
+ Misses       6061     6058    -3     

see 3 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

@doctrino doctrino left a comment

Choose a reason for hiding this comment

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

All for it

@ronpal ronpal enabled auto-merge (squash) May 21, 2026 09:38
@ronpal ronpal merged commit 1e6e9a5 into main May 21, 2026
14 checks passed
@ronpal ronpal deleted the tdl-0004 branch May 21, 2026 09:44
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.

3 participants