[ 
https://issues.apache.org/jira/browse/FLINK-21335?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17281770#comment-17281770
 ] 

Dong Lin commented on FLINK-21335:
----------------------------------

I agree it is better to use "mvn package" if the goal is just to compile the 
Flink and run the quick-start example.

Would it be appropriate to also add the example command to run unit test, since 
this is what most Flink developers (and those who clone the Github source code 
directly) will need to do? And if we do so, then it seems reasonable to also 
use "mvn install" to simply the unit test experience?

I didn't have experience with using Flink or maven previously. And I had the 
question of why "mvn test" not using local Flink source code even after I do 
"mvn package". That is why I think it may make developer experience a bit 
better by updating the README.

I will close the issue if most people prefer to keep the README as is.





> README should use "mvn install" instead of "mvn package" to compile Flink
> -------------------------------------------------------------------------
>
>                 Key: FLINK-21335
>                 URL: https://issues.apache.org/jira/browse/FLINK-21335
>             Project: Flink
>          Issue Type: Improvement
>            Reporter: Dong Lin
>            Priority: Minor
>
> Currently README suggests users to use "mvn package" to build Flink. As a 
> result, the compiled package will not be put in mvn local repository, and 
> "mvn test" will download/use snapshots from remote repository instead of 
> testing local code change.
> This is a bit unintuitive since developers (including those who are not so 
> familiar with maven's mechanism) in general expect "mvn test" to test local 
> code changes.
> So it seems better to update README to use "mvn install" instead of "mvn 
> package". There is no downside of this change to my best knowledge.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Reply via email to