Deploy live doc on push to develop #36636
Conversation
kwankyu
force-pushed
the
p/deploy-livedoc
branch
from
06d5cc8 to
22fa20a
Compare
.github/workflows/doc-build.yml
Outdated
|
|
||
| - name: Build live doc | ||
| id: buildlivedoc | ||
| if: always() && steps.copy.outcome == 'success' && github.ref == 'refs/heads/develop' |
There was a problem hiding this comment.
Perhaps should also conditionalize on github.repository == 'sagemath/sage' so that it does not run in users' forks if they push a change to their develop (instead of creating a specific branch)
There was a problem hiding this comment.
Do I need always() for "Build live doc", "Copy live doc" and "Upload live doc" steps? Perhaps yes.
There was a problem hiding this comment.
It's better to use success() || failure(), see #36617
There was a problem hiding this comment.
Pending to commit the change github.repository == 'sagemath/sage until #36636 (comment) finishes on my own repo.
There was a problem hiding this comment.
But this seems to be a bug on github side.
No, this behavior is by design, but one needs to use it sparingly. Essentially only for releasing resources or for saving logs.
There was a problem hiding this comment.
Pending to commit the change
github.repository == 'sagemath/sage
When done, please go ahead and set the label "positive review".
|
Which version of Sage does the binder environment run? Is it always running the current develop version? Is there a mechanism that triggers the rebuild? |
|
The default branch (master) runs the latest release. The dev branch runs the latest develop version. Both branches are updated everyday, by the scheduled workflow (https://github.com/sagemath/sage-binder-env/tree/master/.github/workflows). The deployed live doc uses the dev branch and runs on the latest dev version of Sage. I plan to use the live doc in the documentation link in our github wiki. |
|
Thanks. Would this be a good moment to revisit: |
|
You mean including sage version in That has one problem. Currently the url of the deployed doc for beta releases does not change and we are relying on the fact in the doc links in the github wiki. A solution would be to deploy the doc twice: once with say I am not sure if this is a good time to revisit #33862 here. As doc build workflows are now touched by a few PRs, I think it is wise to postpone further touch to them. |
|
Thank you! |
|
Documentation preview for this PR (built with commit 9ce90a0; changes) is ready! 🎉 |
sagemathgh-36636: Deploy live doc on push to develop <!-- ^^^^^ Please provide a concise, informative and self-explanatory title. Don't put issue numbers in there, do this in the PR body below. For example, instead of "Fixes sagemath#1234" use "Introduce new method to calculate 1+1" --> <!-- Describe your changes here in detail --> Live doc is built separately from the usual doc preview on push to `develop`, and deployed to Netlify. Sample deployment: https://deploy-livedoc-- sagemath.netlify.app/html/en/a_tour_of_sage/ <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes sagemath#12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> <!-- If your change requires a documentation PR, please link it appropriately --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> <!-- Feel free to remove irrelevant items. --> - [x] The title is concise, informative, and self-explanatory. - [x] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - sagemath#12345: short description why this is a dependency - sagemath#34567: ... --> - sagemath#36601 <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36636 Reported by: Kwankyu Lee Reviewer(s): Kwankyu Lee, Matthias Köppe
sagemathgh-36636: Deploy live doc on push to develop <!-- ^^^^^ Please provide a concise, informative and self-explanatory title. Don't put issue numbers in there, do this in the PR body below. For example, instead of "Fixes sagemath#1234" use "Introduce new method to calculate 1+1" --> <!-- Describe your changes here in detail --> Live doc is built separately from the usual doc preview on push to `develop`, and deployed to Netlify. Sample deployment: https://deploy-livedoc-- sagemath.netlify.app/html/en/a_tour_of_sage/ <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes sagemath#12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> <!-- If your change requires a documentation PR, please link it appropriately --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> <!-- Feel free to remove irrelevant items. --> - [x] The title is concise, informative, and self-explanatory. - [x] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - sagemath#12345: short description why this is a dependency - sagemath#34567: ... --> - sagemath#36601 <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36636 Reported by: Kwankyu Lee Reviewer(s): Kwankyu Lee, Matthias Köppe
3 participants
Live doc is built separately from the usual doc preview on push to
develop, and deployed to Netlify.Sample deployment: https://deploy-livedoc--sagemath.netlify.app/html/en/a_tour_of_sage/
📝 Checklist
⌛ Dependencies