eclipse-theia / theia

Eclipse Theia is a cloud & desktop IDE framework implemented in TypeScript.
http://theia-ide.org
Eclipse Public License 2.0
19.3k stars 2.45k forks source link

Publishing Guide Github Pages #13319

Open jfaltermeier opened 5 months ago

jfaltermeier commented 5 months ago

Bug Description:

It looks like this part of the publishing guide might not be up to date anymore: https://github.com/eclipse-theia/theia/blob/master/doc/Publishing.md#publish-github-pages

At least the workflow was not triggered for a while now: https://github.com/eclipse-theia/theia/actions/workflows/publish-gh-pages.yml

Can we remove this from the guide? If not, this is currently missing for 1.46.0

vince-fugnitto commented 5 months ago

@jfaltermeier I believe it is broken and tracked by https://github.com/eclipse-theia/theia/issues/12846.

JonasHelming commented 2 months ago

@vince-fugnitto I had a look at the Github publishing workflow. It also publishes NPM packages, do you know the reason for this? I would like to change it so that it just publishes the doc and the trigger it from the release build.

vince-fugnitto commented 2 months ago

@JonasHelming the current workflow will build the latest master, and generate documentation based on this (which may differ from what was last published (latest release vs. next)). I believe we also publish to npm as next to reflect the latest master state else documentation might add/remove content which may be misleading.

I still believe it is misleading today, the documentation is not versioned, if it was we could show on the site documentation for community releases and perhaps a single next if we thought it was useful. For users who consult the documentation site, they may be using versions of Theia which do not correspond to the latest information displayed.