Skip to content

feat: build documentation when tagging #103

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

Merged
merged 2 commits into from
Nov 8, 2021

Conversation

tallpress
Copy link
Contributor

@tallpress tallpress commented Nov 3, 2021

Rather than relying on RTD's automation rules. We will trigger the build of the docs from the CI.
We are already doing this with dev docs and it works nicely.

Example HTTP req

❯ curl -X POST -H "Authorization: Token <TOKEN>" https://readthedocs.org/api/v3/projects/eva-python-sdk/versions/docs-v5.0.1/builds/
{"build":{"_links":{"_self":"https://readthedocs.org/api/v3/projects/eva-python-sdk/builds/15173533/","project":"https://readthedocs.org/api/v3/projects/eva-python-sdk/","version":"https://readthedocs.org/api/v3/projects/eva-python-sdk/versions/docs-v5.0.1/"},"commit":null,"created":"2021-11-03T16:43:57.979961Z","duration":null,"error":"","finished":null,"id":15173533,"project":"eva-python-sdk","state":{"code":"triggered","name":"Triggered"},"success":null,"urls":{"build":"https://readthedocs.org/projects/eva-python-sdk/builds/15173533/","project":"https://readthedocs.org/projects/eva-python-sdk/","version":"https://readthedocs.org/dashboard/eva-python-sdk/version/docs-v5.0.1/edit/"},"version":"docs-v5.0.1"},"project":{"_links":{"_self":"https://readthedocs.org/api/v3/projects/eva-python-sdk/","builds":"https://readthedocs.org/api/v3/projects/eva-python-sdk/builds/","environmentvariables":"https://readthedocs.org/api/v3/projects/eva-python-sdk/environmentvariables/","redirects":"https://readthedocs.org/api/v3/projects/eva-python-sdk/redirects/","subprojects":"https://readthedocs.org/api/v3/projects/eva-python-sdk/subprojects/","superproject":"https://readthedocs.org/api/v3/projects/eva-python-sdk/superproject/","translations":"https://readthedocs.org/api/v3/projects/eva-python-sdk/translations/","versions":"https://readthedocs.org/api/v3/projects/eva-python-sdk/versions/"},"created":"2021-05-18T14:33:48.234287Z","default_branch":"development","default_version":"docs-v5.0.1","homepage":null,"id":654177,"language":{"code":"en","name":"English"},"modified":"2021-11-03T16:42:01.707905Z","name":"Eva Python SDK","programming_language":{"code":"words","name":"Only Words"},"repository":{"type":"git","url":"https://github.com/automata-tech/eva_python_sdk"},"slug":"eva-python-sdk","subproject_of":null,"tags":[],"translation_of":null,"urls":{"builds":"https://readthedocs.org/projects/eva-python-sdk/builds/","documentation":"https://eva-python-sdk.readthedocs.io/en/docs-v5.0.1/","home":"https://readthedocs.org/projects/eva-python-sdk/","versions":"https://readthedocs.org/projects/eva-python-sdk/versions/"},"users":[{"username":"tomallpress"},{"username":"lbautomata"}]},"triggered":true,"version":{"_links":{"_self":"https://readthedocs.org/api/v3/projects/eva-python-sdk/versions/docs-v5.0.1/","builds":"https://readthedocs.org/api/v3/projects/eva-python-sdk/versions/docs-v5.0.1/builds/","project":"https://readthedocs.org/api/v3/projects/eva-python-sdk/"},"active":true,"built":true,"downloads":{},"hidden":false,"id":7493409,"identifier":"origin/docs/v5.0.1","ref":null,"slug":"docs-v5.0.1","type":"branch","urls":{"dashboard":{"edit":"https://readthedocs.org/dashboard/eva-python-sdk/version/docs-v5.0.1/edit/"},"documentation":"https://eva-python-sdk.readthedocs.io/en/docs-v5.0.1/","vcs":"https://github.com/automata-tech/eva_p~

https://eva-python-sdk.readthedocs.io/en/docs-v5.0.1/

@LouisBrunner
Copy link
Contributor

Does it set it as the default one as well?

@tallpress
Copy link
Contributor Author

Does it set it as the default one as well?

the default atm is always development, do we want the default to be the most recent tagged version?

@LouisBrunner
Copy link
Contributor

Yes

Copy link
Contributor

@LouisBrunner LouisBrunner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As long as it doesn't conflict with RTD's automation rules

@tallpress
Copy link
Contributor Author

As long as it doesn't conflict with RTD's automation rules

I've removed them

@tallpress tallpress merged commit 9197dbf into development Nov 8, 2021
@tallpress tallpress deleted the feature/build-docs-when-tagging branch November 8, 2021 13:37
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

Successfully merging this pull request may close these issues.

2 participants