Skip to content

Conversation

@jameslamb
Copy link
Collaborator

@jameslamb jameslamb commented Feb 8, 2025

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:

  • no need to check all these HTML/CSS/JS files into source control
  • automatically keeps the docs up to date with the current state of the code (no need to manually re-generate it)

Notes for Reviewers

Replaces #241.

@jameslamb jameslamb added the docs label Feb 8, 2025
@@ -1,4 +1,4 @@
name: Tests
name: ci
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Now CI has more than just tests.

Also this shorter prefix makes it a little easier to read in the UI:

image

Comment on lines +31 to +32
#deploy: ${{ (github.event_name == 'push' && startsWith(github.ref, 'refs/tags')) || (github.event_name == 'workflow_dispatch' && inputs.deploy-docs == true) }}
deploy: true
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Suggested change
#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)
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Suggested change
- 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

image


jobs:
build:
runs-on: macos-latest
Copy link
Collaborator Author

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

@jameslamb jameslamb changed the title WIP: [docs] [ci] update website, move files out of source control [docs] [ci] update website, move files out of source control Feb 8, 2025
@jameslamb jameslamb marked this pull request as ready for review February 8, 2025 06:54
@jameslamb jameslamb changed the title [docs] [ci] update website, move files out of source control [docs] [ci] update website, move docs files out of source control Feb 8, 2025
Copy link
Collaborator

@austin3dickey austin3dickey left a 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!!

@jameslamb
Copy link
Collaborator Author

Thanks for taking a look!

@jameslamb jameslamb merged commit 165ca03 into main Feb 10, 2025
20 checks passed
@jameslamb jameslamb deleted the ci/docs-build-v2 branch February 10, 2025 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants