You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "X-czh (via GitHub)" <gi...@apache.org> on 2024/01/27 16:31:22 UTC
[PR] [FLINK-34052][examples] Install the shaded streaming example jars in the maven repo [flink]
X-czh opened a new pull request, #24206:
URL: https://github.com/apache/flink/pull/24206
<!--
*Thank you very much for contributing to Apache Flink - we are happy that you want to help us improve Flink. To help the community review your contribution in the best possible way, please go through the checklist below, which will get the contribution into a shape in which it can be best reviewed.*
*Please understand that we do not do this to make contributions to Flink a hassle. In order to uphold a high standard of quality for code contributions, while at the same time managing a large number of contributions, we need contributors to prepare the contributions well, and give reviewers enough contextual information for the review. Please also understand that contributions that do not follow this guide will take longer to review and thus typically be picked up with lower priority by the community.*
## Contribution Checklist
- Make sure that the pull request corresponds to a [JIRA issue](https://issues.apache.org/jira/projects/FLINK/issues). Exceptions are made for typos in JavaDoc or documentation files, which need no JIRA issue.
- Name the pull request in the form "[FLINK-XXXX] [component] Title of the pull request", where *FLINK-XXXX* should be replaced by the actual issue number. Skip *component* if you are unsure about which is the best component.
Typo fixes that have no associated JIRA issue should be named following this pattern: `[hotfix] [docs] Fix typo in event time introduction` or `[hotfix] [javadocs] Expand JavaDoc for PuncuatedWatermarkGenerator`.
- Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
- Make sure that the change passes the automated tests, i.e., `mvn clean verify` passes. You can set up Azure Pipelines CI to do that following [this guide](https://cwiki.apache.org/confluence/display/FLINK/Azure+Pipelines#AzurePipelines-Tutorial:SettingupAzurePipelinesforaforkoftheFlinkrepository).
- Each pull request should address only one issue, not mix up code from multiple issues.
- Each commit in the pull request has a meaningful commit message (including the JIRA id)
- Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below.
**(The sections below can be removed for hotfixes of typos)**
-->
## What is the purpose of the change
As a result of the changes implemented in [FLINK-32821](https://issues.apache.org/jira/browse/FLINK-32821), the build process no longer produces artifacts with the names flink-examples-streaming-1.x-yyy.jar. These artifacts were previously available and may still be expected by users as part of their application dependencies. Their removal could potentially break existing build pipelines and applications that depend on these example JARs.
This PR aims to fix it.
## Brief change log
Just add the following config to each example's maven shade config:
```xml
<configuration>
<shadedArtifactAttached>true</shadedArtifactAttached>
<shadedClassifierName>$example-name</shadedClassifierName>
</configuration>
```
**Explanation**:
After invertigation, it turned out that the issue was resulted as follows:
- The maven shade plugin will by default shade replaces with original jar with the result of shading. So, when a pom.xml includes two shades, the second shade execution will (by default) start from the result of the first shade execution ([ref](https://maven.apache.org/plugins/maven-shade-plugin/faq.html)).
- We set the [finalName](https://maven.apache.org/plugins/maven-shade-plugin/shade-mojo.html#finalName) param to prevent the file replacement behavior as we'd like to build multiple independent example jars.
However, maven by default will only install the default project artifact into the repo, omitting those shaded artifacts with finalName specified. This leads to the problem as reported in this issue.
To fix it, we can set the [shadedArtifactAttached](https://maven.apache.org/plugins/maven-shade-plugin/examples/attached-artifact.html) param, which tells maven to install the shaded artifact aside from the default project artifact.
## 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
*(Please pick either of the following options)*
Before the change:
<img width="603" alt="截屏2024-01-27 23 52 04" src="https://github.com/apache/flink/assets/22020529/c3eadef8-df77-48a3-bc7a-7bcb2784d233">
After the change:
<img width="729" alt="截屏2024-01-28 00 06 18" src="https://github.com/apache/flink/assets/22020529/fee1048e-da7f-4beb-a78a-e9a226520589">
And the installed jar includes the datagen connector class files as expected:
<img width="818" alt="截屏2024-01-28 00 08 42" src="https://github.com/apache/flink/assets/22020529/28896c5f-97f2-4782-8b96-c6f5ec689f24">
## Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): (yes / no) no
- The public API, i.e., is any changed class annotated with `@Public(Evolving)`: (yes / no) no
- The serializers: (yes / no / don't know) no
- The runtime per-record code paths (performance sensitive): (yes / no / don't know) no
- Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: (yes / no / don't know) no
- The S3 file system connector: (yes / no / don't know) no
## Documentation
- Does this pull request introduce a new feature? (yes / no) no
- If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented) not applicable
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [FLINK-34052][examples] Install the shaded streaming example jars in the maven repo [flink]
Posted by "flinkbot (via GitHub)" <gi...@apache.org>.
flinkbot commented on PR #24206:
URL: https://github.com/apache/flink/pull/24206#issuecomment-1913252250
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "e6cb657f8c0c2a59e73d2353b594684aa7a76c51",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "e6cb657f8c0c2a59e73d2353b594684aa7a76c51",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* e6cb657f8c0c2a59e73d2353b594684aa7a76c51 UNKNOWN
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [FLINK-34052][examples] Install the shaded streaming example jars in the maven repo [flink]
Posted by "reswqa (via GitHub)" <gi...@apache.org>.
reswqa merged PR #24206:
URL: https://github.com/apache/flink/pull/24206
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org