Skip to content

KAFKA-18203: Add a section for Java version in intellij idea in README#18134

Merged
chia7712 merged 5 commits intoapache:trunkfrom
m1a2st:KAFKA-18203
Dec 13, 2024
Merged

KAFKA-18203: Add a section for Java version in intellij idea in README#18134
chia7712 merged 5 commits intoapache:trunkfrom
m1a2st:KAFKA-18203

Conversation

@m1a2st
Copy link
Copy Markdown
Collaborator

@m1a2st m1a2st commented Dec 11, 2024

Jira: https://issues.apache.org/jira/browse/KAFKA-18203

We should inform developers who want to work on Kafka using IntelliJ IDEA that there are some inconsistent behaviors in IntelliJ. It’s important to notify all developers about these issues to ensure a smoother development experience.

This PR is related with #18104

Committer Checklist (excluded from commit message)

  • Verify design and implementation
  • Verify test coverage and CI build status
  • Verify documentation (including upgrade notes)

@github-actions github-actions bot added triage PRs from the community docs small Small PRs labels Dec 11, 2024
Comment thread README.md Outdated
To contribute follow the instructions here:
* https://kafka.apache.org/contributing.html

### IntelliJ Configuration for Kafka Development ###
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could you please merge this into the Building IDE Project section? Additionally, according to the official Gradle documentation, the IDEA plugin is not necessary. Perhaps we should remove it in this PR as well.

@mumrah mumrah removed the triage PRs from the community label Dec 11, 2024
Comment thread README.md Outdated
build directory (`${project_dir}/bin`) clashes with Kafka's scripts directory and we don't use Gradle's build directory
to avoid known issues with this configuration.

When developing Kafka in IntelliJ, **it is recommended to set the project SDK to Java 17**. While some modules, such as client
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I find the comments a bit verbose. Let's focus on two key points:

  1. Use JDK 17 for Kafka Development:
    Please ensure that JDK 17 is used when developing Kafka.
  2. IntelliJ Language Level Awareness:
    IntelliJ IDEA automatically detects the language level for each module, even if Structure > Project Settings > Modules is not configured.

@chia7712 chia7712 merged commit 6af233e into apache:trunk Dec 13, 2024
tedyu pushed a commit to tedyu/kafka that referenced this pull request Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants