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

Nudge towards building favicons in use_logo() and use_pkgdown() #1996

Closed
wants to merge 4 commits into from

Conversation

olivroy
Copy link
Contributor

@olivroy olivroy commented May 23, 2024

fixes #1995.

I think usethis could run it automatically, but since build_favicons() has an openssl dependency, it may better to let users do it.

Over time, I have encountered many examples of packages that don't use the standard man/figures/logo.png that pkgdown recognizes.

With r-lib/pkgdown#2563, they will no longer be built automatically on gh actions, so they have to be initialized manually by users.

cc: @hadley if you have some views of what should happen here!

)
}

potentially_has_logo <- function() {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This idea came to me, because of PRs I opened in various repos of package devs who didn't seem to be aware of this. see #1995

@hadley
Copy link
Member

hadley commented May 23, 2024

Nice idea! I think you could just run the code if openssl was installed (which I suspect will be the most common case).

@olivroy
Copy link
Contributor Author

olivroy commented May 23, 2024

I just realized that pkgdown is not a usethis dependency, so running the code may cause R CMD CHECK issues after all..

@olivroy
Copy link
Contributor Author

olivroy commented May 31, 2024

r-lib/pkgdown#2611 is a better solution!

@olivroy olivroy closed this May 31, 2024
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.

Should use_logo() call or suggest pkgdown::build_favicons()?
2 participants