ci: Merge all doc builders into one #2934
Conversation
Also move the gh-pages pushing step from the `publish` phase to just this singular doc builder. The motivation for this is to eventually remove the `publish` step since it interacts badly with GitHub's scheduling of actions. This is hopefully the first step towards that by removing the doc publish part of the phase.
There was a problem hiding this comment.
Looks good -- hopefully this will help!
If I understand the docs correctly, it seems that uploads are per workflow run; i.e., doc-api.tar.gz for push 1 on PR 123 and doc-api.tar.gz for force-push 2 on PR 123 will not step on each others' toes (even orthogonal to the only-one-run-per-branch-at-a-time change you made earlier)?
If so, that seems like great news; it means we can upload each tarball in parallel, at the end of individual jobs that produce them (not just docs but our other builds as well); and the gh-pages push is the only bit that needs to be atomic but that is protected by the merge-to-main condition. Or am I missing a gotcha here?
|
Right yeah, the upload-artifact piece will always be independent since there's always a unique workflow and artifacts are uploaded to the workflow. And also yeah the next change would be to have each release builder push up the tarball both as an artifact but also as part of the github release (conditionally). The latter part will stomp over things by default (I mean that's also possible today...) but with the one-build-per-ref I think it greatly reduces the likelihood of that. The good news is that if anything is ever stomped over all the workflows themselves have all the original artifacts so we can just reuse those and manually push them up if anything goes really wrong. |
Also move the gh-pages pushing step from the `publish` phase to just this singular doc builder. The motivation for this is to eventually remove the `publish` step since it interacts badly with GitHub's scheduling of actions. This is hopefully the first step towards that by removing the doc publish part of the phase.
Also move the gh-pages pushing step from the
publishphase to justthis singular doc builder.
The motivation for this is to eventually remove the
publishstep sinceit interacts badly with GitHub's scheduling of actions. This is
hopefully the first step towards that by removing the doc publish part
of the phase.