[NOTICE] Release guide updated for updating japicmp configuration

[Chesnay Schepler-3]

Hello everyone,

We recently decided to enforce compatibility for @PublicEvolving APIs
for minor releases.

This requires modifications to the japicmp-maven-plugin execution on the
corresponding release-X.Y branch after X.Y.Z was released.

In FLINK-17844 new tooling was added to take care of this
(tools/releasing/updated_japicmp_configuration.sh), but it must be run
manually by the release manager, after the release has concluded.

Note that this is also run automatically when an RC is created, as a
final safeguard in case the manual step is missed.

I have amended the release guide accordingly:


      /Update japicmp configuration/

/Update the japicmp reference version and enable API compatibility
checks for //|@PublicEvolving|//APIs on the corresponding SNAPSHOT branch./

/For a new major release (x.y.0), run the same command also on the
master branch for updating the japicmp reference version./

//
/|tools $ NEW_VERSION=$RELEASE_VERSION
releasing|//|/update_japicmp_configuration|//|.sh|/
/|tools $ |//|cd|////|..|/
/|$ git add *|/
/|$ git commit -m |//|"Update japicmp configuration for $RELEASE_VERSION"|/

[Piotr Nowojski-3]

Thanks Chesney for adding those scripts and configuring checks!

Piotrek

> On 29 May 2020, at 10:04, Chesnay Schepler <[hidden email]> wrote:
>
> Hello everyone,
>
> We recently decided to enforce compatibility for @PublicEvolving APIs for minor releases.
>
> This requires modifications to the japicmp-maven-plugin execution on the corresponding release-X.Y branch after X.Y.Z was released.
>
> In FLINK-17844 new tooling was added to take care of this (tools/releasing/updated_japicmp_configuration.sh), but it must be run manually by the release manager, after the release has concluded.
>
> Note that this is also run automatically when an RC is created, as a final safeguard in case the manual step is missed.
>
> I have amended the release guide accordingly:
>
> Update japicmp configuration
>
> Update the japicmp reference version and enable API compatibility checks for @PublicEvolving  APIs on the corresponding SNAPSHOT branch.
>
> For a new major release (x.y.0), run the same command also on the master branch for updating the japicmp reference version.
>
> tools $ NEW_VERSION=$RELEASE_VERSION releasing/update_japicmp_configuration.sh
> tools $ cd ..
> $ git add *
> $ git commit -m "Update japicmp configuration for $RELEASE_VERSION"

[Zhijiang(wangzhijiang999)]

Thanks for the updates, Chesnay!
Really helpful!

Best,
Zhijiang


------------------------------------------------------------------
From:Piotr Nowojski <[hidden email]>
Send Time:2020年5月29日(星期五) 18:03
To:Chesnay Schepler <[hidden email]>
Cc:[hidden email] <[hidden email]>; zhijiang <[hidden email]>
Subject:Re: [NOTICE] Release guide updated for updating japicmp configuration

Thanks Chesney for adding those scripts and configuring checks!

Piotrek


On 29 May 2020, at 10:04, Chesnay Schepler <[hidden email]> wrote:
Hello everyone,
We recently decided to enforce compatibility for @PublicEvolving APIs for minor releases.
This requires modifications to the japicmp-maven-plugin execution on the corresponding release-X.Y branch after X.Y.Z was released.
In FLINK-17844 new tooling was added to take care of this (tools/releasing/updated_japicmp_configuration.sh), but it must be run manually by the release manager, after the release has concluded.
Note that this is also run automatically when an RC is created, as a final safeguard in case the manual step is missed.
I have amended the release guide accordingly: Update japicmp configuration
Update the japicmp reference version and enable API compatibility checks for @PublicEvolving  APIs on the corresponding SNAPSHOT branch.
For a new major release (x.y.0), run the same command also on the master branch for updating the japicmp reference version.  
tools $ NEW_VERSION=$RELEASE_VERSION releasing/update_japicmp_configuration.sh
tools $ cd ..
$ git add *
$ git commit -m "Update japicmp configuration for $RELEASE_VERSION"  

[Yu Li]

Thanks Chesnay for the efforts!

Best Regards,
Yu


On Fri, 29 May 2020 at 18:03, Piotr Nowojski <[hidden email]> wrote:

> Thanks Chesney for adding those scripts and configuring checks!
>
> Piotrek
>
> > On 29 May 2020, at 10:04, Chesnay Schepler <[hidden email]> wrote:
> >
> > Hello everyone,
> >
> > We recently decided to enforce compatibility for @PublicEvolving APIs
> for minor releases.
> >
> > This requires modifications to the japicmp-maven-plugin execution on the
> corresponding release-X.Y branch after X.Y.Z was released.
> >
> > In FLINK-17844 new tooling was added to take care of this
> (tools/releasing/updated_japicmp_configuration.sh), but it must be run
> manually by the release manager, after the release has concluded.
> >
> > Note that this is also run automatically when an RC is created, as a
> final safeguard in case the manual step is missed.
> >
> > I have amended the release guide accordingly:
> >
> > Update japicmp configuration
> >
> > Update the japicmp reference version and enable API compatibility checks
> for @PublicEvolving  APIs on the corresponding SNAPSHOT branch.
> >
> > For a new major release (x.y.0), run the same command also on the master
> branch for updating the japicmp reference version.
> >
> > tools $ NEW_VERSION=$RELEASE_VERSION
> releasing/update_japicmp_configuration.sh
> > tools $ cd ..
> > $ git add *
> > $ git commit -m "Update japicmp configuration for $RELEASE_VERSION"
>
>

[Till Rohrmann]

Thanks for activating the checks and providing the tooling Chesnay.

Cheers,
Till

On Fri, May 29, 2020 at 6:51 PM Yu Li <[hidden email]> wrote:

> Thanks Chesnay for the efforts!
>
> Best Regards,
> Yu
>
>
> On Fri, 29 May 2020 at 18:03, Piotr Nowojski <[hidden email]> wrote:
>
> > Thanks Chesney for adding those scripts and configuring checks!
> >
> > Piotrek
> >
> > > On 29 May 2020, at 10:04, Chesnay Schepler <[hidden email]> wrote:
> > >
> > > Hello everyone,
> > >
> > > We recently decided to enforce compatibility for @PublicEvolving APIs
> > for minor releases.
> > >
> > > This requires modifications to the japicmp-maven-plugin execution on
> the
> > corresponding release-X.Y branch after X.Y.Z was released.
> > >
> > > In FLINK-17844 new tooling was added to take care of this
> > (tools/releasing/updated_japicmp_configuration.sh), but it must be run
> > manually by the release manager, after the release has concluded.
> > >
> > > Note that this is also run automatically when an RC is created, as a
> > final safeguard in case the manual step is missed.
> > >
> > > I have amended the release guide accordingly:
> > >
> > > Update japicmp configuration
> > >
> > > Update the japicmp reference version and enable API compatibility
> checks
> > for @PublicEvolving  APIs on the corresponding SNAPSHOT branch.
> > >
> > > For a new major release (x.y.0), run the same command also on the
> master
> > branch for updating the japicmp reference version.
> > >
> > > tools $ NEW_VERSION=$RELEASE_VERSION
> > releasing/update_japicmp_configuration.sh
> > > tools $ cd ..
> > > $ git add *
> > > $ git commit -m "Update japicmp configuration for $RELEASE_VERSION"
> >
> >
>