You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@flink.apache.org by Seth Wiesman <sj...@gmail.com> on 2021/11/08 15:34:42 UTC

[NOTICE] Please keep flink-examples up to date

Hi Everyone,

I noticed recently that many of the example applications in
`flink-examples/` rely on deprecated apis. I am going to work on upgrading
the examples for the current state of master. Going forward, if you
deprecate a public API please try and double check if that API is being
used in an example and update that example to the new version.

Seth

Re: [NOTICE] Please keep flink-examples up to date

Posted by Seth Wiesman <sj...@gmail.com>.

@David Morávek <dm...@apache.org> great idea! I've opened a subtask to add
that check after we fix the existing deprecations.

Seth

On Mon, Nov 8, 2021 at 12:55 PM David Morávek <dm...@apache.org> wrote:

> Hi Seth, thanks for bringing this up. What do you think about placing a
> safeguard for this? We should be able to setup java compiler for examples
> to fail on any usage of deprecated APIs.
>
> Something along the lines of:
>
> <plugin>
>   <artifactId>maven-compiler-plugin</artifactId>
>   <version>...</version>
>   <executions>
>     <execution>
>       <id>compile</id>
>       <phase>process-sources</phase>
>       <goals>
>         <goal>compile</goal>
>       </goals>
>       <configuration>
>         <compilerArgument>-Xlint:deprecation</compilerArgument>
>         <failOnWarning>true</failOnWarning>
>       </configuration>
>     </execution>
>   </executions>
> </plugin>
>
> Best,
> D.
>
> On Mon, Nov 8, 2021 at 4:59 PM Till Rohrmann <tr...@apache.org> wrote:
>
> > Thanks for raising awareness for keeping our examples up to date. I think
> > this is a very good practice and it also helps our users better
> understand
> > how to use Flink.
> >
> > Cheers,
> > Till
> >
> > On Mon, Nov 8, 2021 at 4:57 PM Fabian Paul <fa...@ververica.com>
> > wrote:
> >
> > > Hi Seth,
> > >
> > > Thanks for brining up this topic.
> > >
> > > Huge appreciations that you take this over initially and we should
> > > definitely
> > > take care as a community to what we show beginner users.
> > >
> > > We can also take the examples as show cases about things we have
> > developed
> > > and
> > > are proud of.
> > >
> > > Best,
> > > Fabian
> >
>

Re: [NOTICE] Please keep flink-examples up to date

Posted by David Morávek <dm...@apache.org>.

Hi Seth, thanks for bringing this up. What do you think about placing a
safeguard for this? We should be able to setup java compiler for examples
to fail on any usage of deprecated APIs.

Something along the lines of:

<plugin>
  <artifactId>maven-compiler-plugin</artifactId>
  <version>...</version>
  <executions>
    <execution>
      <id>compile</id>
      <phase>process-sources</phase>
      <goals>
        <goal>compile</goal>
      </goals>
      <configuration>
        <compilerArgument>-Xlint:deprecation</compilerArgument>
        <failOnWarning>true</failOnWarning>
      </configuration>
    </execution>
  </executions>
</plugin>

Best,
D.

On Mon, Nov 8, 2021 at 4:59 PM Till Rohrmann <tr...@apache.org> wrote:

> Thanks for raising awareness for keeping our examples up to date. I think
> this is a very good practice and it also helps our users better understand
> how to use Flink.
>
> Cheers,
> Till
>
> On Mon, Nov 8, 2021 at 4:57 PM Fabian Paul <fa...@ververica.com>
> wrote:
>
> > Hi Seth,
> >
> > Thanks for brining up this topic.
> >
> > Huge appreciations that you take this over initially and we should
> > definitely
> > take care as a community to what we show beginner users.
> >
> > We can also take the examples as show cases about things we have
> developed
> > and
> > are proud of.
> >
> > Best,
> > Fabian
>

Re: [NOTICE] Please keep flink-examples up to date

Posted by Till Rohrmann <tr...@apache.org>.

Thanks for raising awareness for keeping our examples up to date. I think
this is a very good practice and it also helps our users better understand
how to use Flink.

Cheers,
Till

On Mon, Nov 8, 2021 at 4:57 PM Fabian Paul <fa...@ververica.com> wrote:

> Hi Seth,
>
> Thanks for brining up this topic.
>
> Huge appreciations that you take this over initially and we should
> definitely
> take care as a community to what we show beginner users.
>
> We can also take the examples as show cases about things we have developed
> and
> are proud of.
>
> Best,
> Fabian

Re: [NOTICE] Please keep flink-examples up to date

Posted by Fabian Paul <fa...@ververica.com>.

Hi Seth,

Thanks for brining up this topic.

Huge appreciations that you take this over initially and we should definitely
take care as a community to what we show beginner users.

We can also take the examples as show cases about things we have developed and
are proud of.

Best,
Fabian

Re: [NOTICE] Please keep flink-examples up to date

Posted by Seth Wiesman <sj...@gmail.com>.

Also, please consider adding new examples if you are developing a new API!
It's a great addition to the documentation, and can help you workshop your
change from a usability perspective.

Seth

On Mon, Nov 8, 2021 at 9:34 AM Seth Wiesman <sj...@gmail.com> wrote:

> Hi Everyone,
>
> I noticed recently that many of the example applications in
> `flink-examples/` rely on deprecated apis. I am going to work on upgrading
> the examples for the current state of master. Going forward, if you
> deprecate a public API please try and double check if that API is being
> used in an example and update that example to the new version.
>
> Seth
>