Skip to content
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

[Request action] Action to trigger ReadTheDocs application service #27

Open
LecrisUT opened this issue Jun 8, 2023 · 0 comments
Open

Comments

@LecrisUT
Copy link

LecrisUT commented Jun 8, 2023

Suggestion

Instead of the RTD application always triggering its jobs, first check if in the commit there exists a github workflow that triggers readthedocs/actions/build (or whatever the name will end up being), and if it exists, do NOT trigger the default rtd workflow. Instead, have the action create an appropriate request to trigger it.

This is similar to dfm/rtds-action, but in that case it does not trigger the rtd workflow, it simply uploads the generated documentation. This action is intended to be much simpler, just to trigger the already present rtd workflow.

Benefit

  • fine-grained control of when a RTD action is performed, e.g. only if docs folder is altered
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant