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

Add GitHub Actions workflow to automatically provide readthedocs preview links in PRs that touch docs #3416

Merged
merged 3 commits into from
Nov 28, 2023

Conversation

sgibson91
Copy link
Member

This PR adds a GitHub Action workflow that will automatically add a link to the readthedocs preview to PR descriptions when we make changes within the docs/ folder. An example PR can be seen here: sgibson91/test-multilingual-sphinx#4

@sgibson91 sgibson91 requested a review from a team as a code owner November 14, 2023 09:52
Copy link
Contributor

@consideRatio consideRatio left a comment

Choose a reason for hiding this comment

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

Nice, looks great! :)

@sgibson91
Copy link
Member Author

FYI, I suspect we have the same permission issue here as the other 2 PRs but we don't see it because we have the additional trigger modifier of changes to the docs path

@sgibson91
Copy link
Member Author

Debugging discussion happening in 2i2c-org/docs#194

@sgibson91
Copy link
Member Author

Solution found in 2i2c-org/docs#194 (comment)

@sgibson91 sgibson91 merged commit 59e8f99 into 2i2c-org:master Nov 28, 2023
@sgibson91 sgibson91 deleted the autolink-rtd-preview branch November 28, 2023 16:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: Done 🎉
Development

Successfully merging this pull request may close these issues.

2 participants