Run pkgdown workflow on PR as dry run to test docs #324
+19
−32
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull request overview
This PR enhances the pkgdown workflow to support dry-run testing of documentation on pull requests. The workflow now builds the documentation site for PRs without deploying, while maintaining the existing deployment behavior for pushes to main/master branches.
Changes:
- Added pull request trigger to enable documentation builds on PRs
- Updated action versions and dependencies to use modern consolidated actions
- Split the build and deploy steps to conditionally execute based on event type
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| jobs: | ||
| pkgdown: | ||
| runs-on: ubuntu-latest | ||
| runs-on: ubuntu-22.04 |
There was a problem hiding this comment.
Using a specific Ubuntu version (ubuntu-22.04) instead of ubuntu-latest reduces automatic updates and may require manual maintenance when the version reaches end-of-life. Consider using ubuntu-latest unless there's a specific compatibility requirement.
Suggested change
| runs-on: ubuntu-22.04 | |
| runs-on: ubuntu-latest |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
pkgdown build was still failing after #323. This PR attempts to fix the build again. It also adds PR builds for the pkgdown workflow to act as a dry run for verifying the site build.