flink icon indicating copy to clipboard operation
flink copied to clipboard

[hotfix] [docs] Update README.md to remove Maven

Open asafm opened this issue 1 year ago • 5 comments
trafficstars

What is the purpose of the change

Small fix to README

Brief change log

No need for pre-installed maven, since we have Maven Wrapper

Verifying this change

Please make sure both new and modified tests in this PR follows the conventions defined in our code quality guide: https://flink.apache.org/contributing/code-style-and-quality-common.html#testing

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

asafm avatar Dec 21 '23 13:12 asafm

CI report:

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

flinkbot avatar Dec 21 '23 13:12 flinkbot

having maven wrapper does not protect from running with installed maven

snuyanzin avatar Dec 21 '23 13:12 snuyanzin

@snuyanzin Why would you want users, to run with their installed Maven? If you want all users to have reproducible builds, they should only use the maven wrapper, pinned to a specific version.

asafm avatar Dec 24 '23 15:12 asafm

The PR is incomplete: 1.Removal of requirement for maven is not enough since to make it reproducible there is no info how to enable it in IDE. In that case in terminal there will be wrapper used and in IDE not, if follow instructions only 2. Across the documentation there are lots of mentions of just mvn ... without mentioning ./mvnw 3. Is there any issue which could be reproduced by wrapper and could not be reproduced by installed maven or vice versa or what is the reason to have the restriction to wrapper only?

Why would you want users, to run with their installed Maven?

This is just an option. It could be started with either maven wrapper or with installed maven and for both there is an embedded check against the maven's version in enforcement plugin

snuyanzin avatar Dec 24 '23 21:12 snuyanzin

Guys, I just thought it make sense that if you use internally maven wrapper, then the getting started README should mention that and not "force" users to download maven and run the build incompatible with the way you guys run internally. Feel free to close this PR :)

asafm avatar Dec 28 '23 17:12 asafm