Autorun GH pages job

[callumrollo]

github pages work well for displaying the adoc rendered as html, but it is currently run manually. I propose setting it to run whenever a PR is merged to that it keeps up to date

[castelao]

@callumrollo , thanks for the suggestion. Certainly! Could you take over that one? Were you thinking about something like:

...
  push:
    branches: [ main ]

I was thinking about what to do with PRs. For coding, I usually set up to also run the tests on proposed PRs, but here I'm not sure what would be the best. It would be nice to have a proposed modification compiled to inspect, but we wouldn't want to replace the official document with a proposed one. I don't have a clear plan yet on what to do. Would you have any ideas? Maybe a sandbox area in the OG-Format website?

Thank you!

[callumrollo]

I'm happy to take the lead on this. I would trigger it on push to main and on merge of a PR for starters.

Some kind of integration tests would be nice. We could at least make a check to ensure the adoc compiles. Displaying it as a seperate page on the OG-Format website would be great. I'll look into it

[castelao]

Great! I suggest breaking it into two parts. The auto compilation should be easy. Start with a PR just for that, so we already benefit from it.

Thank you, I do appreciate your help.

[callumrollo]

So, we should be able to autodeploy on each new commit to main with PR #99, that's pretty simple.

I've been looking into ways to build the docs for each new PR and push them to github-pages . I thought we could have a new page for each PR/hash, but this isn't possible as github-pages only allows one branch to push to it.

I think we'll need something like netlify or antora for this. The SOPs were setup in this way to automatically build the jupyter-book and host it using netlify. That workflow was very nice to use, but is currently broken.