Re: History for unreleased versions being published to site

2022-04-20 Thread Francis Chuang 
Great idea regarding commenting out the release notes! I think the 
instructions for releasing should also be updated to remind the RM that 
the release notes should be uncommented (if they were commented) when 
preparing a release as well.


On 21/04/2022 7:10 am, Julian Hyde wrote:

I pushed a commit to Avatica that comments out the release notes.

https://github.com/apache/calcite-avatica/commit/6de8d796b4c388f7c2019fff2c883b8b7909c97e
 


Julian



On Apr 20, 2022, at 1:23 PM, Michael Mior  wrote:

+1 Commented release notes seem to be an easy solution.

--
Michael Mior
mm...@apache.org


Le mer. 20 avr. 2022 à 10:00, Julian Hyde  a écrit :


Usually we don’t add release notes to history.md until the RC vote, so
this isn’t a problem.

But occasionally we want to start writing the rekease notes early. An
example is my recent change to upgrade Avatica’s gradle and Java. For such
changes we could add the release notes for the upcoming release commented
out, and the release manager could uncommon them when preparing the RC.

What you think?

Julian


On Apr 20, 2022, at 5:33 AM, Michael Mior  wrote:

I don't necessarily see this as a problem, although instead of

2022-MM-DD

for the release date, it might be nice to clearly indicate this is
unreleased.
--
Michael Mior
mm...@apache.org



Le mer. 20 avr. 2022 à 08:00, Francis Chuang 

a

écrit :

I noticed that some changes to Calcite's changelog was deployed to the
website automatically: https://calcite.apache.org/docs/history.html

The reason is that in the Github Actions workflow
(


https://github.com/apache/calcite/blob/master/.github/workflows/publish-non-release-website-updates.yml#L24
),


we deploy the site immediately when we update the history.md file. This
is because after a release, there's a possibility that we might need to
go back to update the release date or to make some small tweaks to the
changelog.

I was wondering if we can change history.md, so that the changelog for a
release is only visible if there's a release announcement in the _posts
folder, similar to how the downloads page is generated.

Would anyone familiar with jekyll like to take a stab at this?

Re: History for unreleased versions being published to site

2022-04-20 Thread Julian Hyde 
I pushed a commit to Avatica that comments out the release notes.

https://github.com/apache/calcite-avatica/commit/6de8d796b4c388f7c2019fff2c883b8b7909c97e
 


Julian


> On Apr 20, 2022, at 1:23 PM, Michael Mior  wrote:
> 
> +1 Commented release notes seem to be an easy solution.
> 
> --
> Michael Mior
> mm...@apache.org
> 
> 
> Le mer. 20 avr. 2022 à 10:00, Julian Hyde  a écrit :
> 
>> Usually we don’t add release notes to history.md until the RC vote, so
>> this isn’t a problem.
>> 
>> But occasionally we want to start writing the rekease notes early. An
>> example is my recent change to upgrade Avatica’s gradle and Java. For such
>> changes we could add the release notes for the upcoming release commented
>> out, and the release manager could uncommon them when preparing the RC.
>> 
>> What you think?
>> 
>> Julian
>> 
>>> On Apr 20, 2022, at 5:33 AM, Michael Mior  wrote:
>>> 
>>> I don't necessarily see this as a problem, although instead of
>> 2022-MM-DD
>>> for the release date, it might be nice to clearly indicate this is
>>> unreleased.
>>> --
>>> Michael Mior
>>> mm...@apache.org
>>> 
>>> 
 Le mer. 20 avr. 2022 à 08:00, Francis Chuang 
>> a
 écrit :
 
 I noticed that some changes to Calcite's changelog was deployed to the
 website automatically: https://calcite.apache.org/docs/history.html
 
 The reason is that in the Github Actions workflow
 (
 
>> https://github.com/apache/calcite/blob/master/.github/workflows/publish-non-release-website-updates.yml#L24
>> ),
 
 we deploy the site immediately when we update the history.md file. This
 is because after a release, there's a possibility that we might need to
 go back to update the release date or to make some small tweaks to the
 changelog.
 
 I was wondering if we can change history.md, so that the changelog for a
 release is only visible if there's a release announcement in the _posts
 folder, similar to how the downloads page is generated.
 
 Would anyone familiar with jekyll like to take a stab at this?
 
>>

Re: History for unreleased versions being published to site

2022-04-20 Thread Michael Mior 
+1 Commented release notes seem to be an easy solution.

--
Michael Mior
mm...@apache.org


Le mer. 20 avr. 2022 à 10:00, Julian Hyde  a écrit :

> Usually we don’t add release notes to history.md until the RC vote, so
> this isn’t a problem.
>
> But occasionally we want to start writing the rekease notes early. An
> example is my recent change to upgrade Avatica’s gradle and Java. For such
> changes we could add the release notes for the upcoming release commented
> out, and the release manager could uncommon them when preparing the RC.
>
> What you think?
>
> Julian
>
> > On Apr 20, 2022, at 5:33 AM, Michael Mior  wrote:
> >
> > I don't necessarily see this as a problem, although instead of
> 2022-MM-DD
> > for the release date, it might be nice to clearly indicate this is
> > unreleased.
> > --
> > Michael Mior
> > mm...@apache.org
> >
> >
> >> Le mer. 20 avr. 2022 à 08:00, Francis Chuang 
> a
> >> écrit :
> >>
> >> I noticed that some changes to Calcite's changelog was deployed to the
> >> website automatically: https://calcite.apache.org/docs/history.html
> >>
> >> The reason is that in the Github Actions workflow
> >> (
> >>
> https://github.com/apache/calcite/blob/master/.github/workflows/publish-non-release-website-updates.yml#L24
> ),
> >>
> >> we deploy the site immediately when we update the history.md file. This
> >> is because after a release, there's a possibility that we might need to
> >> go back to update the release date or to make some small tweaks to the
> >> changelog.
> >>
> >> I was wondering if we can change history.md, so that the changelog for a
> >> release is only visible if there's a release announcement in the _posts
> >> folder, similar to how the downloads page is generated.
> >>
> >> Would anyone familiar with jekyll like to take a stab at this?
> >>
>

Re: History for unreleased versions being published to site

2022-04-20 Thread Ruben Q L 
+1 on Julian's proposal.


On Wed, Apr 20, 2022 at 3:00 PM Julian Hyde  wrote:

> Usually we don’t add release notes to history.md until the RC vote, so
> this isn’t a problem.
>
> But occasionally we want to start writing the rekease notes early. An
> example is my recent change to upgrade Avatica’s gradle and Java. For such
> changes we could add the release notes for the upcoming release commented
> out, and the release manager could uncommon them when preparing the RC.
>
> What you think?
>
> Julian
>
> > On Apr 20, 2022, at 5:33 AM, Michael Mior  wrote:
> >
> > I don't necessarily see this as a problem, although instead of
> 2022-MM-DD
> > for the release date, it might be nice to clearly indicate this is
> > unreleased.
> > --
> > Michael Mior
> > mm...@apache.org
> >
> >
> >> Le mer. 20 avr. 2022 à 08:00, Francis Chuang 
> a
> >> écrit :
> >>
> >> I noticed that some changes to Calcite's changelog was deployed to the
> >> website automatically: https://calcite.apache.org/docs/history.html
> >>
> >> The reason is that in the Github Actions workflow
> >> (
> >>
> https://github.com/apache/calcite/blob/master/.github/workflows/publish-non-release-website-updates.yml#L24
> ),
> >>
> >> we deploy the site immediately when we update the history.md file. This
> >> is because after a release, there's a possibility that we might need to
> >> go back to update the release date or to make some small tweaks to the
> >> changelog.
> >>
> >> I was wondering if we can change history.md, so that the changelog for a
> >> release is only visible if there's a release announcement in the _posts
> >> folder, similar to how the downloads page is generated.
> >>
> >> Would anyone familiar with jekyll like to take a stab at this?
> >>
>

Re: History for unreleased versions being published to site

2022-04-20 Thread Julian Hyde 
Usually we don’t add release notes to history.md until the RC vote, so this 
isn’t a problem. 

But occasionally we want to start writing the rekease notes early. An example 
is my recent change to upgrade Avatica’s gradle and Java. For such changes we 
could add the release notes for the upcoming release commented out, and the 
release manager could uncommon them when preparing the RC. 

What you think?

Julian 

> On Apr 20, 2022, at 5:33 AM, Michael Mior  wrote:
> 
> I don't necessarily see this as a problem, although instead of 2022-MM-DD
> for the release date, it might be nice to clearly indicate this is
> unreleased.
> --
> Michael Mior
> mm...@apache.org
> 
> 
>> Le mer. 20 avr. 2022 à 08:00, Francis Chuang  a
>> écrit :
>> 
>> I noticed that some changes to Calcite's changelog was deployed to the
>> website automatically: https://calcite.apache.org/docs/history.html
>> 
>> The reason is that in the Github Actions workflow
>> (
>> https://github.com/apache/calcite/blob/master/.github/workflows/publish-non-release-website-updates.yml#L24),
>> 
>> we deploy the site immediately when we update the history.md file. This
>> is because after a release, there's a possibility that we might need to
>> go back to update the release date or to make some small tweaks to the
>> changelog.
>> 
>> I was wondering if we can change history.md, so that the changelog for a
>> release is only visible if there's a release announcement in the _posts
>> folder, similar to how the downloads page is generated.
>> 
>> Would anyone familiar with jekyll like to take a stab at this?
>>

Re: History for unreleased versions being published to site

2022-04-20 Thread Michael Mior 
I don't necessarily see this as a problem, although instead of 2022-MM-DD
for the release date, it might be nice to clearly indicate this is
unreleased.
--
Michael Mior
mm...@apache.org


Le mer. 20 avr. 2022 à 08:00, Francis Chuang  a
écrit :

> I noticed that some changes to Calcite's changelog was deployed to the
> website automatically: https://calcite.apache.org/docs/history.html
>
> The reason is that in the Github Actions workflow
> (
> https://github.com/apache/calcite/blob/master/.github/workflows/publish-non-release-website-updates.yml#L24),
>
> we deploy the site immediately when we update the history.md file. This
> is because after a release, there's a possibility that we might need to
> go back to update the release date or to make some small tweaks to the
> changelog.
>
> I was wondering if we can change history.md, so that the changelog for a
> release is only visible if there's a release announcement in the _posts
> folder, similar to how the downloads page is generated.
>
> Would anyone familiar with jekyll like to take a stab at this?
>

Re: History for unreleased versions being published to site

2022-04-20 Thread Francis Chuang 
On a second though, the downside with this approach is that the change 
log will not be visible during a vote. Not sure if this is a blocker or 
if directing voters to read the change log on Github is okay.


On 20/04/2022 10:00 pm, Francis Chuang wrote:
I noticed that some changes to Calcite's changelog was deployed to the 
website automatically: https://calcite.apache.org/docs/history.html


The reason is that in the Github Actions workflow 
(https://github.com/apache/calcite/blob/master/.github/workflows/publish-non-release-website-updates.yml#L24), 
we deploy the site immediately when we update the history.md file. This 
is because after a release, there's a possibility that we might need to 
go back to update the release date or to make some small tweaks to the 
changelog.


I was wondering if we can change history.md, so that the changelog for a 
release is only visible if there's a release announcement in the _posts 
folder, similar to how the downloads page is generated.


Would anyone familiar with jekyll like to take a stab at this?

History for unreleased versions being published to site

2022-04-20 Thread Francis Chuang 
I noticed that some changes to Calcite's changelog was deployed to the 
website automatically: https://calcite.apache.org/docs/history.html


The reason is that in the Github Actions workflow 
(https://github.com/apache/calcite/blob/master/.github/workflows/publish-non-release-website-updates.yml#L24), 
we deploy the site immediately when we update the history.md file. This 
is because after a release, there's a possibility that we might need to 
go back to update the release date or to make some small tweaks to the 
changelog.


I was wondering if we can change history.md, so that the changelog for a 
release is only visible if there's a release announcement in the _posts 
folder, similar to how the downloads page is generated.


Would anyone familiar with jekyll like to take a stab at this?