WIP Add github action for building doc

[lucyleeow]

closes #7

[larsoner]

I have not seen a way to make actions take effect in the PR that adds them. Probably worth looking into if you want to test this. Otherwise you'll be stuck actually pushing a branch to this repo (rather than your own) which is annoying.

Actually I guess you could just look here:

https://github.com/lucyleeow/sample-project/actions

I'd recommend enabling Actions debug mode on your repo, too

[lucyleeow]

@larsoner I wasn't sure how best to name the github action workflow .yml file. I called it sphinx_build.yml - is this reasonable?

I used the community workflows sphinx build action and upload artifacts - reasonable?

Otherwise good to go.

[larsoner]

I used the community workflows sphinx build action and upload artifacts - reasonable?

I would use whatever is most common + easy + supported, sounds like these probably are

One thing that is missing is some sort of status update, is there a GitHub action to make a link to one of the artifacts that is produced by the upload artifacts step (e.g., the index.html)? If not it might be worth building a simple one. See for example the action I wrote (which is more complicated) to monitor CircleCI status badges and make a GitHub status link to their artifacts:

https://github.com/larsoner/circleci-artifacts-redirector-action

[lucyleeow]

I don't think there is a way to do that: https://github.community/t5/GitHub-Actions/Link-to-latest-artifacts/td-p/36394

Further you can only download the artifact, and cannot get a link to view the html pages directly. And there does not even seem to be a way to get a link to download the uploaded artifact - actions/upload-artifact#27

[larsoner]

These seem like pretty bad deficiencies compared to CircleCI to the point where I would not recommend people use GitHub actions...

[lucyleeow]

I agree. Maybe we can table this until this feature is added? @GaelVaroquaux feel free to pitch in.

[larsoner]

FYI I'm fine with merging this as is, too, so long as we add some comment noting the limitations we've hit. It's still useful to have as a template in case people don't care about the limitation, or if at some point we figure out how to get around it.

[lucyleeow]

I don't mind either way. I'm working on some documentation in README.md atm so can discuss this there. I guess CircleCI is a bit tricker to set up at the start...

[lucyleeow]

Merging this and noting limitations in readme

[choldgraf]

wait @larsoner didn't you build a github actions bot just to do this very thing?

[larsoner]

For CircleCI artifacts yes, not for GitHub actions artifacts

[choldgraf]

Ohhh I see - I thought that https://github.com/larsoner/circleci-artifacts-redirector-action was doing this, but I guess that's just an action to look at the CircleCI artifacts, not to point to GHA artifacts