-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
First draft for read the doc integration #14
base: main
Are you sure you want to change the base?
Conversation
@@ -172,3 +180,11 @@ runs: | |||
done | |||
echo "::endgroup::" | |||
shell: bash -l {0} | |||
- name: Trigger RTDs build | |||
id: readthedocs-trigger | |||
if: ${{ inputs.rtds_webhook_url != '' && inputs.rtds_webhook_token == ''}} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if: ${{ inputs.rtds_webhook_url != '' && inputs.rtds_webhook_token == ''}} | |
if: ${{ inputs.rtds_webhook_url != '' && inputs.rtds_webhook_token != ''}} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the initiative @fredboudon .
More than the technical implementation, my question about this is concerns the interest of this approach:
- Should we insert the doc building inside the
action-build-publish-anaconda
action ? - One clear advantage is that it makes more uniform all processes associated with package building in OpenAlea (but then, should we also insert the tests for example ?). - Drawbacks are that we add another two of many parameters and this gets difficult to apprehend (even if most of them have default values or are not mandatory).
- Also, we lose in flexibility : unless we take care of the different cases, we have to stick to readthedocs (i.e. only sphinx and MkDocs so far, if I'm not wrong)
- Finally, having a separate GH-action for building doc would make it more flexible: not need for specific hack as proposed here, and possibility to build the doc when the developper wants (push at master, or tag, or ...). This is probably more in line with classical devops workflow.
I see advantages / disadvantages, so I have no firm opinion about it. What do you think ? Also, maybe an opinion @pradal ?
Thanks guys. Is it a replacement of readthedoc service? Not clear for me... |
I agree that a separate workflow would have some advantages. Still the documentation requires the package to be built (to generate the API documentation). This is why I put everything in the same workflow. In a case of separated workflow, we should investigate how to trigger a second workflow (documentation) after a first one (package build). Maybe you've already looked to this ? Or you have other idea to coordinate the 2 workflows ? |
In fact each workflow is composed of several tasks that are linked in a specific order. |
I propose a very first draft for readthedoc integration. To discuss on this pull request.