[doc] Add documents for adding dependencies to flink-agents project. #467
+278
−22
Conversation
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
github-actions
bot
added
priority/major
wenjin272
force-pushed
the
doc-maven
branch
2 times, most recently
from
5872828 to
3897ac2
Compare
xintongsong
reviewed
Jan 23, 2026
| </parent> | ||
|
|
||
| <artifactId>flink-agents-ide-support</artifactId> | ||
| <name>Flink Agents : IDE Support</name> |
Contributor
There was a problem hiding this comment.
Let's add a <description> here to explain what this artifact is for. Otherwise, it's a bit implicit.
|
|
||
| **Required for developing Agent applications:** | ||
| - `flink-agents-api` - Core API for Flink-Agents | ||
| - `flink-streaming-java` and `flink-table-api-java` - Core API for Flink |
Contributor
There was a problem hiding this comment.
Suggested change
| - `flink-streaming-java` and `flink-table-api-java` - Core API for Flink | |
| - `flink-streaming-java` and/or `flink-table-api-java` - Core API for Flink |
|
|
||
| **Additional dependencies for running in IDE:** | ||
| - `flink-agents-ide-support` - Runtime execution dependencies (required for local execution/testing). | ||
|
|
Contributor
There was a problem hiding this comment.
Let's use "required" vs. "optional" here.
We should explain that, unlike running in a Flink cluster, when running in IDE, runtime dependencies are absent, so we need this additional dependency, and use "run with provided dependencies" feature of IDE.
And we should emphasis to use provided scope.
…flink-agents in IDE.
Co-authored-by: Shekharrajak <shekharrajak@live.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Linked issue: #393
Purpose of change
flink-agents-runtime-bundlemodule to decrease the complexity for users to introduce execution dependencies in flink-agents project.Tests
No
API
No
Documentation
doc-neededdoc-not-neededdoc-included