2.7.0 release notes inconsistent with released code

[Tim Robertson <ti...@gmail.com>]

Hi folks

Our release notes [1] for 2.7.0 say that Beam supports Elasticsearch 6 (
BEAM-5107 <https://issues.apache.org/jira/browse/BEAM-5107>). The 2.7.0
code [2] however does not seem to, while master does [3]. The PR [4] was
merged on the 6th September and in the 2.7.0 chat I see that Charles
announced:

I will cut the initial 2.7.0 release branch on September 7.

Is this a case of unfortunate timing (it was cut early?) and we just
overlooked cherry picking that commit do you think?

Do we correct release notes when mistakes are spotted?

Thanks,
Tim

[1]
https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12319527&version=12343654
[2]
https://github.com/apache/beam/blob/release-2.7.0/sdks/java/io/elasticsearch/src/main/java/org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.java#L1243
[3]
https://github.com/apache/beam/blob/master/sdks/java/io/elasticsearch/src/main/java/org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.java#L1268
[4] https://github.com/apache/beam/pull/6211

Re: 2.7.0 release notes inconsistent with released code

[Kenneth Knowles <ke...@apache.org>]

On Mon, Oct 8, 2018 at 3:17 AM Tim Robertson <ti...@gmail.com>
wrote:

>
> Do we correct release notes when mistakes are spotted?
>

I think we should, yes. Release notes are long-lived documents that should
be accurate. The correction should be mentioned in the notes so that anyone
who previously read the incorrect release notes is alerted.

Kenn

Re: 2.7.0 release notes inconsistent with released code

[Tim Robertson <ti...@gmail.com>]

Thanks Andrew - and sorry folks, that was simply me doing a bad email
search as I looked into the issue. I don't think there is much more to do
communicate.

I just corrected the label in Jira and I see the release notes are updated
automatically - I'm not sure how we can include a note to say that adjusted
though as they seem fully dynamic. I presume it is enough as it is?






On Mon, Oct 8, 2018 at 6:39 PM Thomas Weise <th...@apache.org> wrote:

> As I understand, Tim's concern is the accuracy of the release notes,
> and +1 for correcting them. In the end it does not matter that much to the
> users when a release was proposed to be cut vs. when it actually happened,
> but what they get with the release.
>
> Perhaps between the contributors we could going forward just mention as of
> what commit the actual release occurred? Ultimately it is
> reviewer/contributor responsibility that issues they work on are marked
> with the correct fix version. There was some related discussion on when to
> set the fix version on issues. I think that it is best to defer that until
> the PR is merged and the issue resolved, to avoid confusion.
>
>
> On Mon, Oct 8, 2018 at 9:11 AM Andrew Pilloud <ap...@google.com> wrote:
>
>> Keep reading the proposal thread and you'll find: "We should follow the
>> calendar and aim to cut on 8/29, not 9/7 as I incorrectly wrote earlier."
>> There were several folowup emails in the thread with reminders of the
>> release cut date. Is there something we should do to better communicate
>> release cuts in the future?
>>
>>
>> https://lists.apache.org/thread.html/c4da2a5594d22121b5864662e64a027148993b5e0187ce5beda2714e@%3Cdev.beam.apache.org%3E
>>
>> Andrew
>>
>> On Mon, Oct 8, 2018 at 3:17 AM Tim Robertson <ti...@gmail.com>
>> wrote:
>>
>>> Hi folks
>>>
>>> Our release notes [1] for 2.7.0 say that Beam supports Elasticsearch 6 (
>>> BEAM-5107 <https://issues.apache.org/jira/browse/BEAM-5107>). The 2.7.0
>>> code [2] however does not seem to, while master does [3]. The PR [4] was
>>> merged on the 6th September and in the 2.7.0 chat I see that Charles
>>> announced:
>>>
>>> I will cut the initial 2.7.0 release branch on September 7.
>>>
>>> Is this a case of unfortunate timing (it was cut early?) and we just
>>> overlooked cherry picking that commit do you think?
>>>
>>> Do we correct release notes when mistakes are spotted?
>>>
>>> Thanks,
>>> Tim
>>>
>>> [1]
>>> https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12319527&version=12343654
>>> [2]
>>> https://github.com/apache/beam/blob/release-2.7.0/sdks/java/io/elasticsearch/src/main/java/org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.java#L1243
>>> [3]
>>> https://github.com/apache/beam/blob/master/sdks/java/io/elasticsearch/src/main/java/org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.java#L1268
>>> [4] https://github.com/apache/beam/pull/6211
>>>
>>

Re: 2.7.0 release notes inconsistent with released code

[Thomas Weise <th...@apache.org>]

As I understand, Tim's concern is the accuracy of the release notes, and +1
for correcting them. In the end it does not matter that much to the users
when a release was proposed to be cut vs. when it actually happened, but
what they get with the release.

Perhaps between the contributors we could going forward just mention as of
what commit the actual release occurred? Ultimately it is
reviewer/contributor responsibility that issues they work on are marked
with the correct fix version. There was some related discussion on when to
set the fix version on issues. I think that it is best to defer that until
the PR is merged and the issue resolved, to avoid confusion.


On Mon, Oct 8, 2018 at 9:11 AM Andrew Pilloud <ap...@google.com> wrote:

> Keep reading the proposal thread and you'll find: "We should follow the
> calendar and aim to cut on 8/29, not 9/7 as I incorrectly wrote earlier."
> There were several folowup emails in the thread with reminders of the
> release cut date. Is there something we should do to better communicate
> release cuts in the future?
>
>
> https://lists.apache.org/thread.html/c4da2a5594d22121b5864662e64a027148993b5e0187ce5beda2714e@%3Cdev.beam.apache.org%3E
>
> Andrew
>
> On Mon, Oct 8, 2018 at 3:17 AM Tim Robertson <ti...@gmail.com>
> wrote:
>
>> Hi folks
>>
>> Our release notes [1] for 2.7.0 say that Beam supports Elasticsearch 6 (
>> BEAM-5107 <https://issues.apache.org/jira/browse/BEAM-5107>). The 2.7.0
>> code [2] however does not seem to, while master does [3]. The PR [4] was
>> merged on the 6th September and in the 2.7.0 chat I see that Charles
>> announced:
>>
>> I will cut the initial 2.7.0 release branch on September 7.
>>
>> Is this a case of unfortunate timing (it was cut early?) and we just
>> overlooked cherry picking that commit do you think?
>>
>> Do we correct release notes when mistakes are spotted?
>>
>> Thanks,
>> Tim
>>
>> [1]
>> https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12319527&version=12343654
>> [2]
>> https://github.com/apache/beam/blob/release-2.7.0/sdks/java/io/elasticsearch/src/main/java/org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.java#L1243
>> [3]
>> https://github.com/apache/beam/blob/master/sdks/java/io/elasticsearch/src/main/java/org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.java#L1268
>> [4] https://github.com/apache/beam/pull/6211
>>
>

Re: 2.7.0 release notes inconsistent with released code

[Andrew Pilloud <ap...@google.com>]

Keep reading the proposal thread and you'll find: "We should follow the
calendar and aim to cut on 8/29, not 9/7 as I incorrectly wrote earlier."
There were several folowup emails in the thread with reminders of the
release cut date. Is there something we should do to better communicate
release cuts in the future?

https://lists.apache.org/thread.html/c4da2a5594d22121b5864662e64a027148993b5e0187ce5beda2714e@%3Cdev.beam.apache.org%3E

Andrew

On Mon, Oct 8, 2018 at 3:17 AM Tim Robertson <ti...@gmail.com>
wrote:

> Hi folks
>
> Our release notes [1] for 2.7.0 say that Beam supports Elasticsearch 6 (
> BEAM-5107 <https://issues.apache.org/jira/browse/BEAM-5107>). The 2.7.0
> code [2] however does not seem to, while master does [3]. The PR [4] was
> merged on the 6th September and in the 2.7.0 chat I see that Charles
> announced:
>
> I will cut the initial 2.7.0 release branch on September 7.
>
> Is this a case of unfortunate timing (it was cut early?) and we just
> overlooked cherry picking that commit do you think?
>
> Do we correct release notes when mistakes are spotted?
>
> Thanks,
> Tim
>
> [1]
> https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12319527&version=12343654
> [2]
> https://github.com/apache/beam/blob/release-2.7.0/sdks/java/io/elasticsearch/src/main/java/org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.java#L1243
> [3]
> https://github.com/apache/beam/blob/master/sdks/java/io/elasticsearch/src/main/java/org/apache/beam/sdk/io/elasticsearch/ElasticsearchIO.java#L1268
> [4] https://github.com/apache/beam/pull/6211
>