Skip to content
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

Merged

Conversation

ReenigneArcher
Copy link
Member

@ReenigneArcher ReenigneArcher commented Mar 6, 2025

Description

This PR adds the ability to preview website builds by using Read the Docs.

Screenshot

Issues Fixed or Closed

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Dependency update (updates to dependencies)
  • Documentation update (changes to documentation)
  • Repository update (changes to repository files, e.g. .github/...)

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

@ReenigneArcher ReenigneArcher force-pushed the ci/gh-pages/preview-website-for-PR-builds-in-RTD branch 2 times, most recently from 05810ef to af39546 Compare March 6, 2025 00:49
Copy link

codecov bot commented Mar 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 11.61%. Comparing base (fd9f10f) to head (7100fd4).
Report is 1 commits behind head on master.

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     
Flag Coverage Δ
Linux 11.28% <ø> (ø)
Windows 13.01% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

see 31 files with indirect coverage changes

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@ReenigneArcher ReenigneArcher force-pushed the ci/gh-pages/preview-website-for-PR-builds-in-RTD branch 2 times, most recently from 6cc9653 to ba2fa67 Compare March 6, 2025 03:06
@ReenigneArcher ReenigneArcher force-pushed the ci/gh-pages/preview-website-for-PR-builds-in-RTD branch from ba2fa67 to 7100fd4 Compare March 6, 2025 03:26
@ReenigneArcher ReenigneArcher marked this pull request as ready for review March 6, 2025 03:34
@ReenigneArcher ReenigneArcher requested a review from Copilot March 6, 2025 03:35
Copy link

@Copilot Copilot AI left a 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"
Copy link
Preview

Copilot AI Mar 6, 2025

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.

Suggested change
branch="master"
branch="${BRANCH_NAME:-master}"

Copilot is powered by AI, so mistakes are possible. Review output carefully before use.

Positive Feedback
Negative Feedback

Provide additional feedback

Please help us improve GitHub Copilot by sharing more details about this comment.

Please select one or more of the options
Copy link

sonarqubecloud bot commented Mar 6, 2025

@ReenigneArcher ReenigneArcher enabled auto-merge (squash) March 6, 2025 03:37
@ReenigneArcher ReenigneArcher merged commit 7cda5fa into master Mar 6, 2025
38 checks passed
@ReenigneArcher ReenigneArcher deleted the ci/gh-pages/preview-website-for-PR-builds-in-RTD branch March 6, 2025 04:09
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.

1 participant