-
Notifications
You must be signed in to change notification settings - Fork 35
[docs] [ci] update website, move docs files out of source control #244
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
Conversation
| @@ -1,4 +1,4 @@ | |||
| name: Tests | |||
| name: ci | |||
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.
| #deploy: ${{ (github.event_name == 'push' && startsWith(github.ref, 'refs/tags')) || (github.event_name == 'workflow_dispatch' && inputs.deploy-docs == true) }} | ||
| deploy: true |
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.
| #deploy: ${{ (github.event_name == 'push' && startsWith(github.ref, 'refs/tags')) || (github.event_name == 'workflow_dispatch' && inputs.deploy-docs == true) }} | |
| deploy: true | |
| deploy: ${{ (github.event_name == 'push' && startsWith(github.ref, 'refs/tags')) || (github.event_name == 'workflow_dispatch' && inputs.deploy-docs == true) }} |
TODO: revert this before merging.
I'm proposing only updating the docs site on the builds triggered by merges to main. Just had this set to true to test this PR.
|
|
||
| reference: | ||
| - title: Main function | ||
| - title: Main function (DELETE ME) |
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.
| - title: Main function (DELETE ME) | |
| - title: Main function |
TODO: remove this before merging.
Put this here to prove that docs deployed this way are making it to the site: https://uptake.github.io/uptasticsearch/reference/index.html
|
|
||
| jobs: | ||
| build: | ||
| runs-on: macos-latest |
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.
Proposing using macOS because CRAN has pre-built binaries there. So CI is faster and less likely to fail with could-not-build-some-dependency-from-source types of errors.
The docs build takes around 3 minutes to run on macOS: https://github.com/uptake/uptasticsearch/actions/runs/13212614464/job/36888065982?pr=244
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.
This is so much better! Thanks!!
|
Thanks for taking a look! |

Testing moving docs deployments to this pattern:
https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow
Benefits:
Notes for Reviewers
Replaces #241.