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

Check readme images after building reference and articles #2494

Merged
merged 6 commits into from
May 7, 2024
Merged

Conversation

hadley
Copy link
Member

@hadley hadley commented Apr 24, 2024

We can't know if the images in a readme exist until we have built the rest of the site. We worked around this a bit for images in man/figures but that strategy doesn't work for articles since we actually need to build them. So now we just check in a new step at the end of build_site().

Fixes #2194

We can't know if the images in a readme exist until we have built the rest of the site. We worked around this a bit for images in `man/figures` but that strategy doesn't work for articles since we actually need to build them. So now we just check in a new step at the end of `build_site()`.

Fixes #2194
@hadley hadley requested a review from maelle April 24, 2024 13:18
@hadley hadley changed the title Check readme images after build refrence and articles Check readme images after building reference and articles Apr 24, 2024
R/check.R Show resolved Hide resolved
Copy link

github-actions bot commented May 6, 2024

@maelle
Copy link
Collaborator

maelle commented May 7, 2024

Different from r-lib/covr#482?

@hadley
Copy link
Member Author

hadley commented May 7, 2024

@maelle yeah, because the test actually fails when run by covr.

@hadley hadley merged commit e706979 into main May 7, 2024
13 checks passed
@hadley hadley deleted the check-readme branch May 7, 2024 12:55
SebKrantz pushed a commit to SebKrantz/pkgdown that referenced this pull request Jun 1, 2024
We can't know if the images in a readme exist until we have built the rest of the site. We worked around this a bit for images in `man/figures` but that strategy doesn't work for articles since we actually need to build them. So now we just check in a new step at the end of `build_site()`.

Fixes r-lib#2194
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.

False warning for missing (articles) images in README.md
2 participants