-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
ci(gh-pages): preview website for PR builds in RTD #3709
ci(gh-pages): preview website for PR builds in RTD #3709
Conversation
05810ef
to
af39546
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3709 +/- ##
=========================================
Coverage 11.61% 11.61%
=========================================
Files 92 92
Lines 17337 17337
Branches 8100 8100
=========================================
Hits 2013 2013
+ Misses 14727 12833 -1894
- Partials 597 2491 +1894
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
6cc9653
to
ba2fa67
Compare
ba2fa67
to
7100fd4
Compare
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.
PR Overview
This PR introduces a Read the Docs configuration to enable website build previews for PR builds.
- Added a new .readthedocs.yaml configuration file tailored for PR preview builds.
- Configured build jobs to download and execute a custom build script.
Reviewed Changes
File | Description |
---|---|
gh-pages-template/.readthedocs.yaml | New configuration file to set up and run RTD builds for PRs |
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
install: | ||
- | | ||
mkdir -p "./tmp" | ||
branch="master" |
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.
Hardcoding the branch as 'master' could lead to issues if the repository's default branch changes. Consider parameterizing the branch name to improve configurability.
branch="master" | |
branch="${BRANCH_NAME:-master}" |
Copilot is powered by AI, so mistakes are possible. Review output carefully before use.
|
Description
This PR adds the ability to preview website builds by using Read the Docs.
Screenshot
Issues Fixed or Closed
Type of Change
.github/...
)Checklist