Skip to content

[FLINK-39714][docs] Backport AGENTS.md and AI disclosure#28204

Merged
snuyanzin merged 2 commits into
apache:release-1.20from
liuml07:FLINK-39714-release-1.20
May 20, 2026
Merged

[FLINK-39714][docs] Backport AGENTS.md and AI disclosure#28204
snuyanzin merged 2 commits into
apache:release-1.20from
liuml07:FLINK-39714-release-1.20

Conversation

@liuml07
Copy link
Copy Markdown
Member

@liuml07 liuml07 commented May 19, 2026

What is the purpose of the change

Backport of AGENTS.md and the AI disclosure section of pull request template to release-1.20, so AI coding agents working on backports here find the same conventions they get on master.

Brief change log

  • Commit 1: copy AGENTS.md and the PR template additions verbatim from current master (FLINK-39477 + FLINK-39623).
  • Commit 2: adapt AGENTS.md to this release branch — drop references to modules/files that don't exist here (e.g., flink-models, flink-metrics-otel, DEVELOPMENT.md, and where relevant the Java prerequisite line).

Follows up on review feedback from #28179.

Verifying this change

This change is a trivial rework / code cleanup without any test coverage.

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

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

Documentation

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

Was generative AI tooling used to co-author this PR?
  • Yes — Claude Opus 4.7 (1M context)

Generated-by: Claude Opus 4.7 (1M context)

liuml07 added 2 commits May 19, 2026 14:44
Brings AGENTS.md and the AI disclosure section of the PR template to
this release branch so AI coding agents working on backports find the
same conventions they get on master.

Content sourced verbatim from current apache/master, which combines:

- FLINK-39477 (master commit 55d0cc6, also on release-2.3 as
  8aba8c9): initial introduction of AGENTS.md and the AI
  disclosure section of .github/PULL_REQUEST_TEMPLATE.md.
- FLINK-39623 (master commit d1e3d13): later AGENTS.md additions
  (the "Codegen vs hand-written operators" bullet under Architecture
  Boundaries, and the "Release Notes" bullet under Pull request
  conventions). These have not yet been backported to release-2.3.

This commit does not use git cherry-pick because the desired content
combines two separate master commits; the references above record the
original sources.

Generated-by: Claude Opus 4.7 (1M context)
Removes references to modules and files that exist on master but not on
release-1.20, and corrects the Java version statement to match this
branch.

- Java prerequisites (line 26): default is Java 8 (deprecated) per
  release-1.20 pom.xml (target.java.version=1.8); Java 11 is the
  recommended runtime per docs/content/docs/deployment/java_compatibility.md;
  Java 17 is still experimental on this line. Java 21 is not documented
  for release-1.20, so remove it from the prerequisites list.
- flink-metrics-otel: not present on release-1.20; drop from the
  metrics reporter implementations bullet.
- flink-models (and sub-modules flink-model-openai, flink-model-triton):
  not present on release-1.20; drop the bullet under "Other".
- DEVELOPMENT.md: introduced by FLIP-561 (master commit ccaa2eb),
  not backported to release-1.20; drop the link from References.

Generated-by: Claude Opus 4.7 (1M context)
@liuml07 liuml07 changed the title FLINK-39714][docs] Backport AGENTS.md and AI disclosure [FLINK-39714][docs] Backport AGENTS.md and AI disclosure May 19, 2026
@flinkbot
Copy link
Copy Markdown
Collaborator

flinkbot commented May 19, 2026

CI report:

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

Copy link
Copy Markdown
Contributor

@raminqaf raminqaf left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for the backport!

@github-actions github-actions Bot added the community-reviewed PR has been reviewed by the community. label May 20, 2026
@snuyanzin snuyanzin merged commit dd21933 into apache:release-1.20 May 20, 2026
@liuml07 liuml07 deleted the FLINK-39714-release-1.20 branch May 20, 2026 19:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community-reviewed PR has been reviewed by the community. target:release-1.20

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants