Skip to content

MINOR: Various README tweaks #18301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ijuma merged 2 commits into from
Dec 23, 2024
Merged

MINOR: Various README tweaks #18301

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
24b5695
MINOR: Various README tweaks
ijuma Dec 22, 2024
5da5343
Add `-PskipSigning=true`
ijuma Dec 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@ See our [web site](https://kafka.apache.org) for details on the project.

You need to have [Java](http://www.oracle.com/technetwork/java/javase/downloads/index.html) installed.

We build and test Apache Kafka with 17 and 23. The `release` parameter in javac and scalac is set to `11` for the clients
and streams modules, and `17` for the broker and tools, ensuring compatibility with their respective minimum Java versions.
We build and test Apache Kafka with 17 and 23. The `release` parameter in javac is set to `11` for the clients
and streams modules, and `17` for the rest, ensuring compatibility with their respective
minimum Java versions. Similarly, the `release` parameter in scalac is set to `11` for the streams modules and `17`
for the rest.

Scala 2.13 is the only supported version in Apache Kafka.

Expand Down Expand Up @@ -96,7 +98,7 @@ fail due to code changes. You can just run:

./gradlew processMessages processTestMessages

### Running a Kafka broker in KRaft mode
### Running a Kafka broker

Using compiled files:

Expand Down Expand Up @@ -127,20 +129,17 @@ Streams has multiple sub-projects, but you can run all the tests:
### Building IDE project ####
*Note Please ensure that JDK17 is used when developing Kafka.*

*Note that this is not strictly necessary (IntelliJ IDEA has good built-in support for Gradle projects, for example).*
IntelliJ supports Gradle natively and it will automatically check Java syntax and compatibility for each module, even if
the Java version shown in the `Structure > Project Settings > Modules` may not be the correct one.

When it comes to Eclipse, run:

./gradlew eclipse
./gradlew idea
Copy link
Copy Markdown
Member

@chia7712 chia7712 Dec 23, 2024

Choose a reason for hiding this comment

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

maybe we can remove idea plugin from build.gradle?

https://github.com/apache/kafka/blob/trunk/build.gradle#L35

Copy link
Copy Markdown
Member Author

@ijuma ijuma Dec 23, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

This is a larger change as it would break someone who is using this plugin in their workflow (for whatever reason). I'd prefer to start by removing it from the README (to keep things simple for new contributors) and leaving the actual plugin removal for later. Is that reasonable?


The `eclipse` task has been configured to use `${project_dir}/build_eclipse` as Eclipse's build directory. Eclipse's default
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.

IntelliJ Language Level awareness:

IntelliJ will automatically check Java syntax and compatibility for each module, even if the Java version is not
explicitly set in the Structure > Project Settings > Modules.

### Publishing the streams quickstart archetype artifact to maven ###
For the Streams archetype project, one cannot use gradle to upload to maven; instead the `mvn deploy` command needs to be called at the quickstart folder:

Expand Down Expand Up @@ -170,6 +169,10 @@ Please note for this to work you should create/update user maven settings (typic
</servers>
...

### Installing all projects to the local Maven repository ###

./gradlew -PskipSigning=true publishToMavenLocal

### Installing specific projects to the local Maven repository ###

./gradlew -PskipSigning=true :streams:publishToMavenLocal
Expand Down