emscripten icon indicating copy to clipboard operation
emscripten copied to clipboard

Automatic publishing of documentation website via GH action

Open sbc100 opened this issue 2 months ago • 5 comments

The emscripten documentation is sadly (a) hosted in a different github org and (b) requires manual building and updated.

I think it would be great to have GH action on main branch and will automatically send a PR to the docs site every time there are any changes.

I like that idea of generating a PR so we can see if/when/how the html files actually change.

The instructions for updating the site are here: https://github.com/emscripten-core/emscripten/blob/main/docs/process.md#updating-the-emscriptenorg-website

sbc100 avatar Oct 26 '25 23:10 sbc100

@dschuff would you be able to look into this maybe? Since you have been so great and getting GH actions work recently :)

sbc100 avatar Oct 26 '25 23:10 sbc100

I use https://github.com/JamesIves/github-pages-deploy-action but I'd understand if you didn't want to use a third party script. It also directly commits rather than making a PR.

curiousdannii avatar Oct 27 '25 11:10 curiousdannii

Yeah, that looks pretty straightforward, it seems like it could work pretty similarly to how we trigger release updates between emsdk and emscripten today.

dschuff avatar Oct 27 '25 11:10 dschuff

I use https://github.com/JamesIves/github-pages-deploy-action but I'd understand if you didn't want to use a third party script. It also directly commits rather than making a PR.

Maybe yes, but I would also like to have the ability to run the thing locally too. Is that possible with such actions, or does all the action happen remotely with those things?

We also already have a script ready to go: https://github.com/emscripten-core/emscripten/blob/main/tools/maint/update_docs.py. So it seems like using that might be a good idea? Otherwise we end up with a two completely different ways of doing it.

Maybe if we go with third_party action we should delete our local script at least

sbc100 avatar Oct 27 '25 15:10 sbc100

I've never tried running a GitHub action locally... I doubt it would work fully.

curiousdannii avatar Oct 27 '25 19:10 curiousdannii