Skip to content

[FLINK-39539][table] Document changelog processing in AGENTS.md#28027

Draft
gustavodemorais wants to merge 1 commit intoapache:masterfrom
confluentinc:FLINK-39539
Draft

[FLINK-39539][table] Document changelog processing in AGENTS.md#28027
gustavodemorais wants to merge 1 commit intoapache:masterfrom
confluentinc:FLINK-39539

Conversation

@gustavodemorais
Copy link
Copy Markdown
Contributor

What is the purpose of the change

As recently discussed in the mailing list, we want to work towards have more extensive and high quality Agents.md context files to make the codebase work better with AI. In that sense, we want to add a more detailed information regarding CDC processing inside Flink and how our components work.

Brief change log

  • Add section to root AGENTS.md
  • Add section to planner AGENTS.md
  • Add section to runtime AGENTS.md

Verifying this change

  • Fact check information added

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): (no)
  • The public API, i.e., is any changed class annotated with @Public(Evolving): (no)
  • The serializers: (no)
  • The runtime per-record code paths (performance sensitive): (no)
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: (no)
  • The S3 file system connector: (no)

Documentation

  • Does this pull request introduce a new feature? (no)
  • If yes, how is the feature documented? ()

Was generative AI tooling used to co-author this PR?
  • Yes (please specify the tool below)

2.1.117 (Claude Code)

@flinkbot
Copy link
Copy Markdown
Collaborator

flinkbot commented Apr 24, 2026

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

Adds Changelog Processing sections to the root, planner, and runtime
AGENTS.md covering: RowKind / ChangelogMode model, two-pass trait
inference, primary vs unique vs upsert keys (incl. nullability),
ChangelogNormalize and SinkUpsertMaterializer (V1, V2,
WatermarkCompactingSinkMaterializer) lifecycle, the two-timestamps
model (StreamRecord envelope vs row event-time column), FLIP-558 and
FLIP-564 framing, and SQL best practices.
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.

2 participants