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

Post link in PRs when RTD docs have been built #1610

Closed
WalterKolczynski-NOAA opened this issue May 15, 2023 · 0 comments · Fixed by #1786
Closed

Post link in PRs when RTD docs have been built #1610

WalterKolczynski-NOAA opened this issue May 15, 2023 · 0 comments · Fixed by #1786
Assignees
Labels
CI/CD Issue related to CI/CD documentation Improvements or additions to documentation feature New feature or request

Comments

@WalterKolczynski-NOAA
Copy link
Contributor

Description
We have turned on documentation building for PRs at ReadTheDocs. The link is of the form https://global-workflow--{pr_number}.org.readthedocs.build/en/{pr_number}/. But the only way to get there is either knowing the link or getting there through the RTD project dashboard.

Requirements
A comment on the PR with a link to the RTD documentation built from the PR.

Acceptance Criteria (Definition of Done)
Meet requirements.

(Optional): Suggest A Solution
Not sure whether the best solution is to add it to the existing GH action, or use some sort of webhook.

Also, with documentation being built for PRs on RTD, I don't know what parts of the existing GH action are still even needed. At the very least, we likely do not need to upload the artifacts anymore. Will need to evaluate how much the RTD build relies on our GH action.

@WalterKolczynski-NOAA WalterKolczynski-NOAA added documentation Improvements or additions to documentation feature New feature or request labels May 15, 2023
@WalterKolczynski-NOAA WalterKolczynski-NOAA added the CI/CD Issue related to CI/CD label May 25, 2023
WalterKolczynski-NOAA pushed a commit that referenced this issue Aug 9, 2023
Create a message in PR with link to the PR's ReadTheDocs before it's merged.

Fixes #1610
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD Issue related to CI/CD documentation Improvements or additions to documentation feature New feature or request
Projects
None yet
2 participants