Skip to content

Conversation

@nielsbasjes
Copy link
Contributor

What is the purpose of the change

Make the build output more human readable for the developers van various situations.

Brief change log

Add or change the <name> of each maven module (i.e. in every pom.xml)

Verifying this change

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

The simplest way to test is by doing a mvn clean and verify the list of names at the end looks good.
Also looking at the change set verify that the names for each module are correct.

In some exceptional cases I made the name reflect a bit more the purpose like in the case of
flink-examples/flink-examples-build-helper where the description indicates This is a utility module for building example jars to be used in flink-dist. so I named it Flink : Examples : Dist :

Fun fact: I noticed that the ordering of the modules during the build is changed a lot by maven because apparently the ordering of the modules in the pom.xml does not meet the configured dependencies between the modules. So maven reorders the build by itself.

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): no
  • The public API, i.e., is any changed class annotated with @Public(Evolving): no
  • The serializers: no
  • The runtime per-record code paths (performance sensitive): no
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn/Mesos, ZooKeeper: no
  • The S3 file system connector: no

Documentation

  • Does this pull request introduce a new feature? no

@nielsbasjes
Copy link
Contributor Author

nielsbasjes commented Jul 15, 2020

Note that all <packaging>pom</packaging> modules have a name that ends with <space>:<space> because that makes the ordering in the Maven overview in IntelliJ better.

Also note that the naming convention I show here is based upon my own preference: what I find easy to read.

@flinkbot
Copy link
Collaborator

Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.

Automated Checks

Last check on commit bcd598e (Wed Jul 15 12:11:46 UTC 2020)

Warnings:

  • 187 pom.xml files were touched: Check for build and licensing issues.
  • No documentation files were touched! Remember to keep the Flink docs up to date!
  • This pull request references an unassigned Jira ticket. According to the code contribution guide, tickets need to be assigned before starting with the implementation work.

Mention the bot in a comment to re-run the automated checks.

Review Progress

  • ❓ 1. The [description] looks good.
  • ❓ 2. There is [consensus] that the contribution should go into to Flink.
  • ❓ 3. Needs [attention] from.
  • ❓ 4. The change fits into the overall [architecture].
  • ❓ 5. Overall code [quality] is good.

Please see the Pull Request Review Guide for a full explanation of the review process.

Details
The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required Bot commands
The @flinkbot bot supports the following commands:

  • @flinkbot approve description to approve one or more aspects (aspects: description, consensus, architecture and quality)
  • @flinkbot approve all to approve all aspects
  • @flinkbot approve-until architecture to approve everything until architecture
  • @flinkbot attention @username1 [@username2 ..] to require somebody's attention
  • @flinkbot disapprove architecture to remove an approval you gave earlier

@flinkbot
Copy link
Collaborator

flinkbot commented Jul 15, 2020

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run travis re-run the last Travis build
  • @flinkbot run azure re-run the last Azure build


<artifactId>flink-examples-streaming-gcp-pubsub_${scala.binary.version}</artifactId>
<name>flink-examples-streaming-gcp-pubsub</name>
<name>Flink : Examples : Dist : Streaming Google PubSub</name>
Copy link
Contributor

Choose a reason for hiding this comment

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

Dist -> Helper?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, can be. I had doubts about this one. The artifact name is build helper yet the purpose is making it available in the dist.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For now I made it consistent with the module artifact name : "Build Helper".

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I personally would rename this to something like "dist helper" or "dist examples" but that is a separate change if desired.

@aljoscha aljoscha self-requested a review July 15, 2020 14:05
@nielsbasjes nielsbasjes force-pushed the FLINK-18607-Name-Modules branch from bcd598e to b4f6dd1 Compare July 21, 2020 08:30
@KurtYoung
Copy link
Contributor

@nielsbasjes Thanks for the update, I will merge this once tests passed.

@KurtYoung KurtYoung merged commit 2cca80f into apache:master Jul 22, 2020
Copy link
Contributor

@aljoscha aljoscha left a comment

Choose a reason for hiding this comment

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

Retroactive approval! And I trust Kurts review.

@nielsbasjes nielsbasjes deleted the FLINK-18607-Name-Modules branch July 23, 2020 17:56
RyanSkraba pushed a commit to RyanSkraba/flink that referenced this pull request Jan 25, 2023
jnh5y pushed a commit to jnh5y/flink that referenced this pull request Dec 18, 2023
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.

5 participants