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

Functions for checking pkgdown.yaml without building #2056

Closed
gravesti opened this issue Mar 8, 2022 · 0 comments · Fixed by #2118
Closed

Functions for checking pkgdown.yaml without building #2056

gravesti opened this issue Mar 8, 2022 · 0 comments · Fixed by #2118
Labels
deploy ✈️ feature a feature request or enhancement
Milestone

Comments

@gravesti
Copy link

gravesti commented Mar 8, 2022

Hi pkgdown team, I'm looking at implementing a pre-commit git hook for our developers to make sure that they have updated the pkgdown.yaml so we can avoid those Topics missing from index: my_new_function errors on the later checks.
It looks like this could be mostly achieved with

build_reference_index()
build_articles_index()

However to make it a bit faster and to avoid having to have Pandoc available in the pre-commit environment, I'm wondering if it would be possible to have this functionality but without the call to render_page()?
Or maybe it would be enough to export data_reference_index and data_articles_index?

@hadley hadley added feature a feature request or enhancement deploy ✈️ labels May 31, 2022
@hadley hadley added this to the v2.0.4 milestone Jun 8, 2022
hadley added a commit that referenced this issue Jun 9, 2022
* Error, regardless of whether we're on CI or not (#2055)
* New `check_pkgdown()` for lightweight check of validity (#2056).
hadley added a commit that referenced this issue Jun 9, 2022
* Error, regardless of whether we're on CI or not (Fixes #2055)
* New `check_pkgdown()` for lightweight check of validity (Fixes #2056).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deploy ✈️ feature a feature request or enhancement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants