Skip to content

Add manual trigger to RTD preview, run workflow on forks. #1083

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Apr 1, 2025
Merged

Add manual trigger to RTD preview, run workflow on forks. #1083

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a6087b1
Add manual trigger to RTD preview.
nikoshell Mar 30, 2025
c98382b
Execute RTP Preview only for forks.
nikoshell Mar 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/rtd-preview.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,14 @@ on:
pull_request_target:
types:
- opened
workflow_dispatch:

permissions:
pull-requests: write

jobs:
documentation-links:
if: github.event.pull_request.head.repo.fork == true
Copy link
Member

@egeakman egeakman Mar 31, 2025

Choose a reason for hiding this comment

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

We were talking about entirely moving to RTD for previews. I think we can just remove preview.yml.

@artcz thoughts?

Copy link
Contributor Author

@nikoshell nikoshell Apr 1, 2025

Choose a reason for hiding this comment

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

RTD is failing right now with undefined reason and it's blocking few PR.
this change keep current preview which is working fine for pull requests and use RTP for forks.

Copy link
Contributor

@artcz artcz Apr 1, 2025

Choose a reason for hiding this comment

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

Yes, some of the builds are failing – the speaker one is because of the pipx missing (which maybe we should migrate to uvx :D), but the other one doesn't have an obvious reason in the output.

I think it might be a good idea to keep RTD preview just for forks, because that way we also don't overload the RTD servers with unnecessary previews, plus we're testing closer to the same setup as production if we keep the same preview flow.

Looking at our server, so far we generated ~350 previews totalling 6.5G in the last ~two months.

runs-on: ubuntu-latest
timeout-minutes: 10
steps:
Expand Down