Files
shiny/tools/documentation/checkDocsCurrent.sh
Barret Schloerke 83628facb3 Use roxygen2 reexport setup for htmltools and fastmap (#2795)
* Remove all hard copied man files

* Move fastmap reexports into ./R/rexport-fastmap.R

* Update htmltools man script to look for the latest tag and make a reexports file

* document

* Update htmltools reexports to listen to ./inst/_htmltools_reexports.json file. Fix pkgdown failure.

* Allow for any package reexports. Currently fastmap and htmltools

* remove progress dependency

* add back skip on cran for pkgdown

* Test pkgdown only if called using devtools::test or within CI

* Removed outdated import docs file. Moved pkgdown and reexports files into ./tools/documentation. Updated travis file.

* add local test for pkgdown

* updated comments and added a debug comment

* print the repo url and close it

* print the downloaded repo tag info

* use gh package and make sure it's installed

* add PAT to travis and remove username from gh::gh call

* skip pkgdown test on cran and add comments
2020-03-20 14:25:18 -04:00

35 lines
1.2 KiB
Bash
Executable File

#!/bin/bash
set -e
# Generate package docs in the working directory
echo "Document..."
Rscript -e "devtools::document(roclets=c('rd', 'collate', 'namespace'))"
if [ -n "$(git status --porcelain)" ]
then
git status --porcelain
>&2 echo "Please generate the Roxygen documentation and commit the updates."
>&2 echo "The above files changed when we generated the Roxygen documentation. This most often occurs when a user changes the Roxygen documentation in an R file but doesn't regenerate the documentation before committing."
exit 1
else
echo "No difference detected; Roxygen docs are current."
fi
# Update htmltools docs
echo "Update Reexports..."
Rscript './tools/documentation/updateReexports.R'
echo "Check pkgdown..."
Rscript './tools/documentation/checkPkgdown.R'
if [ -n "$(git status --porcelain)" ]
then
git status --porcelain
>&2 echo "Please generate the reexports documentation and commit the updates."
>&2 echo "The above files changed when we generated the reexports documentation by calling './tools/documentation/updateReexports.R'. This most often occurs when the documentation re-exported by shiny does not match the latest tagged package exports."
exit 1
else
echo "No difference detected; re-exported docs are current."
fi