You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@calcite.apache.org by Francis Chuang <fr...@apache.org> on 2022/03/31 05:06:56 UTC

[DISCUSS] Automated website builds

Hey everyone,

I just pushed [1], [2] and [3] to calcite, calcite-avatica and 
calcite-avatica-go to implement automated website builds. As a test 
commit, I fixed the release announcement for Calcite 1.30.0 [4]. It was 
built by Github actions in run 2068981585 [5] and was deployed to 
calcite-site in commit 401cc9b154af584b4babb5bfd68e6fa4d4f020bd [6]. The 
actual website at https://calcite.apache.org/ still has not reflected 
the latest changes, but I think it's just a bit slow synchronizing.

I have added some filters to stop code changes from being published 
before a release for calcite-avatica and calcite-avatica-go.
See:
- 
https://github.com/apache/calcite-avatica/blob/master/.github/workflows/publish-non-release-website-updates.yml#L8
- 
https://github.com/apache/calcite-avatica-go/blob/master/.github/workflows/publish-website.yml#L10
- 
https://github.com/apache/calcite-avatica-go/blob/master/.github/workflows/publish-website.yml#L26
- 
https://github.com/apache/calcite-avatica/blob/master/site/add-avatica-go-docs.sh#L22

Please test this out when updating the website in the future and report 
any issues or edge-cases.

Francis

[1] 
https://github.com/apache/calcite/commit/970ba276e78f15e65382b6d881519a65d1a60d45

[2] 
https://github.com/apache/calcite-avatica/commit/b9aa1fb97189c082598daa72d997451878a25cbf

[3] 
https://github.com/apache/calcite-avatica-go/commit/00df39b540bcb009a6b80de37fe16dfcc4d02a07

[4] 
https://github.com/apache/calcite/commit/f43a43141d4cd1e4d4b14799e7ec820d27298512

[5] https://github.com/apache/calcite/actions/runs/2068981585

[6] 
https://github.com/apache/calcite-site/commit/401cc9b154af584b4babb5bfd68e6fa4d4f020bd

Re: [DISCUSS] Automated website builds

Posted by xiong duan <no...@gmail.com>.
Hi Francis,
      Thanks for the reply. I missed the discussion in
https://lists.apache.org/thread/dqw6hbrpwkc9bsdhbyjv42nvrvbhwbt2. Great
work!

Francis Chuang <fr...@apache.org> 于2022年4月2日周六 15:44写道:

> Hey Xiong,
>
> The Github action will automatically build the javadoc and deploy it
> when a release is tagged. See:
>
> https://github.com/apache/calcite/blob/master/.github/workflows/publish-website-on-release.yml#L48
>
> Francis
>
> On 2/04/2022 6:30 pm, xiong duan wrote:
> > Hi Francis,
> >      This is good to me. And this is very helpful.
> >       But have a little problem, I noticed you removed the The procedure
> for
> > deploying changes to the website. If we change the Java doc(The Class or
> > the method) in https://calcite.apache.org/javadocAggregate/, maybe we
> still
> > need this? Or I mistake something?
> >
> > Francis Chuang <fr...@apache.org> 于2022年3月31日周四 13:49写道:
> >
> >> Okay, so I think the reason we're not seeing changes being deployed to
> >> calcite.apache.org is because the Git repo is not syncing via Gitbox.
> >>
> >> See https://git-wip-us.apache.org/repos/asf?p=calcite-site.git vs
> >> https://github.com/apache/calcite-site/commits/master
> >>
> >> I've triggered a resync using
> https://gitbox.apache.org/setup/resync.cgi
> >> and will ping infra if the issue persists.
> >>
> >> Francis
> >>
> >> On 31/03/2022 4:06 pm, Francis Chuang wrote:
> >>> Hey everyone,
> >>>
> >>> I just pushed [1], [2] and [3] to calcite, calcite-avatica and
> >>> calcite-avatica-go to implement automated website builds. As a test
> >>> commit, I fixed the release announcement for Calcite 1.30.0 [4]. It was
> >>> built by Github actions in run 2068981585 [5] and was deployed to
> >>> calcite-site in commit 401cc9b154af584b4babb5bfd68e6fa4d4f020bd [6].
> The
> >>> actual website at https://calcite.apache.org/ still has not reflected
> >>> the latest changes, but I think it's just a bit slow synchronizing.
> >>>
> >>> I have added some filters to stop code changes from being published
> >>> before a release for calcite-avatica and calcite-avatica-go.
> >>> See:
> >>> -
> >>>
> >>
> https://github.com/apache/calcite-avatica/blob/master/.github/workflows/publish-non-release-website-updates.yml#L8
> >>>
> >>> -
> >>>
> >>
> https://github.com/apache/calcite-avatica-go/blob/master/.github/workflows/publish-website.yml#L10
> >>>
> >>> -
> >>>
> >>
> https://github.com/apache/calcite-avatica-go/blob/master/.github/workflows/publish-website.yml#L26
> >>>
> >>> -
> >>>
> >>
> https://github.com/apache/calcite-avatica/blob/master/site/add-avatica-go-docs.sh#L22
> >>>
> >>>
> >>> Please test this out when updating the website in the future and report
> >>> any issues or edge-cases.
> >>>
> >>> Francis
> >>>
> >>> [1]
> >>>
> >>
> https://github.com/apache/calcite/commit/970ba276e78f15e65382b6d881519a65d1a60d45
> >>>
> >>>
> >>> [2]
> >>>
> >>
> https://github.com/apache/calcite-avatica/commit/b9aa1fb97189c082598daa72d997451878a25cbf
> >>>
> >>>
> >>> [3]
> >>>
> >>
> https://github.com/apache/calcite-avatica-go/commit/00df39b540bcb009a6b80de37fe16dfcc4d02a07
> >>>
> >>>
> >>> [4]
> >>>
> >>
> https://github.com/apache/calcite/commit/f43a43141d4cd1e4d4b14799e7ec820d27298512
> >>>
> >>>
> >>> [5] https://github.com/apache/calcite/actions/runs/2068981585
> >>>
> >>> [6]
> >>>
> >>
> https://github.com/apache/calcite-site/commit/401cc9b154af584b4babb5bfd68e6fa4d4f020bd
> >>>
> >>
> >
>

Re: [DISCUSS] Automated website builds

Posted by Francis Chuang <fr...@apache.org>.
Hey Xiong,

The Github action will automatically build the javadoc and deploy it 
when a release is tagged. See: 
https://github.com/apache/calcite/blob/master/.github/workflows/publish-website-on-release.yml#L48

Francis

On 2/04/2022 6:30 pm, xiong duan wrote:
> Hi Francis,
>      This is good to me. And this is very helpful.
>       But have a little problem, I noticed you removed the The procedure for
> deploying changes to the website. If we change the Java doc(The Class or
> the method) in https://calcite.apache.org/javadocAggregate/, maybe we still
> need this? Or I mistake something?
> 
> Francis Chuang <fr...@apache.org> 于2022年3月31日周四 13:49写道:
> 
>> Okay, so I think the reason we're not seeing changes being deployed to
>> calcite.apache.org is because the Git repo is not syncing via Gitbox.
>>
>> See https://git-wip-us.apache.org/repos/asf?p=calcite-site.git vs
>> https://github.com/apache/calcite-site/commits/master
>>
>> I've triggered a resync using https://gitbox.apache.org/setup/resync.cgi
>> and will ping infra if the issue persists.
>>
>> Francis
>>
>> On 31/03/2022 4:06 pm, Francis Chuang wrote:
>>> Hey everyone,
>>>
>>> I just pushed [1], [2] and [3] to calcite, calcite-avatica and
>>> calcite-avatica-go to implement automated website builds. As a test
>>> commit, I fixed the release announcement for Calcite 1.30.0 [4]. It was
>>> built by Github actions in run 2068981585 [5] and was deployed to
>>> calcite-site in commit 401cc9b154af584b4babb5bfd68e6fa4d4f020bd [6]. The
>>> actual website at https://calcite.apache.org/ still has not reflected
>>> the latest changes, but I think it's just a bit slow synchronizing.
>>>
>>> I have added some filters to stop code changes from being published
>>> before a release for calcite-avatica and calcite-avatica-go.
>>> See:
>>> -
>>>
>> https://github.com/apache/calcite-avatica/blob/master/.github/workflows/publish-non-release-website-updates.yml#L8
>>>
>>> -
>>>
>> https://github.com/apache/calcite-avatica-go/blob/master/.github/workflows/publish-website.yml#L10
>>>
>>> -
>>>
>> https://github.com/apache/calcite-avatica-go/blob/master/.github/workflows/publish-website.yml#L26
>>>
>>> -
>>>
>> https://github.com/apache/calcite-avatica/blob/master/site/add-avatica-go-docs.sh#L22
>>>
>>>
>>> Please test this out when updating the website in the future and report
>>> any issues or edge-cases.
>>>
>>> Francis
>>>
>>> [1]
>>>
>> https://github.com/apache/calcite/commit/970ba276e78f15e65382b6d881519a65d1a60d45
>>>
>>>
>>> [2]
>>>
>> https://github.com/apache/calcite-avatica/commit/b9aa1fb97189c082598daa72d997451878a25cbf
>>>
>>>
>>> [3]
>>>
>> https://github.com/apache/calcite-avatica-go/commit/00df39b540bcb009a6b80de37fe16dfcc4d02a07
>>>
>>>
>>> [4]
>>>
>> https://github.com/apache/calcite/commit/f43a43141d4cd1e4d4b14799e7ec820d27298512
>>>
>>>
>>> [5] https://github.com/apache/calcite/actions/runs/2068981585
>>>
>>> [6]
>>>
>> https://github.com/apache/calcite-site/commit/401cc9b154af584b4babb5bfd68e6fa4d4f020bd
>>>
>>
> 

Re: [DISCUSS] Automated website builds

Posted by xiong duan <no...@gmail.com>.
Hi Francis,
    This is good to me. And this is very helpful.
     But have a little problem, I noticed you removed the The procedure for
deploying changes to the website. If we change the Java doc(The Class or
the method) in https://calcite.apache.org/javadocAggregate/, maybe we still
need this? Or I mistake something?

Francis Chuang <fr...@apache.org> 于2022年3月31日周四 13:49写道:

> Okay, so I think the reason we're not seeing changes being deployed to
> calcite.apache.org is because the Git repo is not syncing via Gitbox.
>
> See https://git-wip-us.apache.org/repos/asf?p=calcite-site.git vs
> https://github.com/apache/calcite-site/commits/master
>
> I've triggered a resync using https://gitbox.apache.org/setup/resync.cgi
> and will ping infra if the issue persists.
>
> Francis
>
> On 31/03/2022 4:06 pm, Francis Chuang wrote:
> > Hey everyone,
> >
> > I just pushed [1], [2] and [3] to calcite, calcite-avatica and
> > calcite-avatica-go to implement automated website builds. As a test
> > commit, I fixed the release announcement for Calcite 1.30.0 [4]. It was
> > built by Github actions in run 2068981585 [5] and was deployed to
> > calcite-site in commit 401cc9b154af584b4babb5bfd68e6fa4d4f020bd [6]. The
> > actual website at https://calcite.apache.org/ still has not reflected
> > the latest changes, but I think it's just a bit slow synchronizing.
> >
> > I have added some filters to stop code changes from being published
> > before a release for calcite-avatica and calcite-avatica-go.
> > See:
> > -
> >
> https://github.com/apache/calcite-avatica/blob/master/.github/workflows/publish-non-release-website-updates.yml#L8
> >
> > -
> >
> https://github.com/apache/calcite-avatica-go/blob/master/.github/workflows/publish-website.yml#L10
> >
> > -
> >
> https://github.com/apache/calcite-avatica-go/blob/master/.github/workflows/publish-website.yml#L26
> >
> > -
> >
> https://github.com/apache/calcite-avatica/blob/master/site/add-avatica-go-docs.sh#L22
> >
> >
> > Please test this out when updating the website in the future and report
> > any issues or edge-cases.
> >
> > Francis
> >
> > [1]
> >
> https://github.com/apache/calcite/commit/970ba276e78f15e65382b6d881519a65d1a60d45
> >
> >
> > [2]
> >
> https://github.com/apache/calcite-avatica/commit/b9aa1fb97189c082598daa72d997451878a25cbf
> >
> >
> > [3]
> >
> https://github.com/apache/calcite-avatica-go/commit/00df39b540bcb009a6b80de37fe16dfcc4d02a07
> >
> >
> > [4]
> >
> https://github.com/apache/calcite/commit/f43a43141d4cd1e4d4b14799e7ec820d27298512
> >
> >
> > [5] https://github.com/apache/calcite/actions/runs/2068981585
> >
> > [6]
> >
> https://github.com/apache/calcite-site/commit/401cc9b154af584b4babb5bfd68e6fa4d4f020bd
> >
>

Re: [DISCUSS] Automated website builds

Posted by Francis Chuang <fr...@apache.org>.
Okay, so I think the reason we're not seeing changes being deployed to 
calcite.apache.org is because the Git repo is not syncing via Gitbox.

See https://git-wip-us.apache.org/repos/asf?p=calcite-site.git vs 
https://github.com/apache/calcite-site/commits/master

I've triggered a resync using https://gitbox.apache.org/setup/resync.cgi 
and will ping infra if the issue persists.

Francis

On 31/03/2022 4:06 pm, Francis Chuang wrote:
> Hey everyone,
> 
> I just pushed [1], [2] and [3] to calcite, calcite-avatica and 
> calcite-avatica-go to implement automated website builds. As a test 
> commit, I fixed the release announcement for Calcite 1.30.0 [4]. It was 
> built by Github actions in run 2068981585 [5] and was deployed to 
> calcite-site in commit 401cc9b154af584b4babb5bfd68e6fa4d4f020bd [6]. The 
> actual website at https://calcite.apache.org/ still has not reflected 
> the latest changes, but I think it's just a bit slow synchronizing.
> 
> I have added some filters to stop code changes from being published 
> before a release for calcite-avatica and calcite-avatica-go.
> See:
> - 
> https://github.com/apache/calcite-avatica/blob/master/.github/workflows/publish-non-release-website-updates.yml#L8 
> 
> - 
> https://github.com/apache/calcite-avatica-go/blob/master/.github/workflows/publish-website.yml#L10 
> 
> - 
> https://github.com/apache/calcite-avatica-go/blob/master/.github/workflows/publish-website.yml#L26 
> 
> - 
> https://github.com/apache/calcite-avatica/blob/master/site/add-avatica-go-docs.sh#L22 
> 
> 
> Please test this out when updating the website in the future and report 
> any issues or edge-cases.
> 
> Francis
> 
> [1] 
> https://github.com/apache/calcite/commit/970ba276e78f15e65382b6d881519a65d1a60d45 
> 
> 
> [2] 
> https://github.com/apache/calcite-avatica/commit/b9aa1fb97189c082598daa72d997451878a25cbf 
> 
> 
> [3] 
> https://github.com/apache/calcite-avatica-go/commit/00df39b540bcb009a6b80de37fe16dfcc4d02a07 
> 
> 
> [4] 
> https://github.com/apache/calcite/commit/f43a43141d4cd1e4d4b14799e7ec820d27298512 
> 
> 
> [5] https://github.com/apache/calcite/actions/runs/2068981585
> 
> [6] 
> https://github.com/apache/calcite-site/commit/401cc9b154af584b4babb5bfd68e6fa4d4f020bd 
>