#120: add reusable workflow to check pkgdown builds.

[k-doering-NOAA]

This pull request addresses #120.

@Bai-Li-NOAA this is ready for testing. I think you can use a file like the below to test on a branch.

I did try testing using the file below on the ghactions4r pkgdown site. I broke the pkgdown build, and confirmed that the github action failed. I also confirmed that the html was saved as an artifact for successful runs (these commits were on the check-pkgdown branch, but I have removed them).

# Checks that the pkgdown site builds for a repository.
# this assumes pkgdown is already set up.
name: call-build-pkgdown
# on specifies the build triggers. See more info at https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows
on:
  push:
jobs:
  call-workflow:
    uses: nmfs-fish-tools/ghactions4r/.github/workflows/build-pkgdown.yml@check-pkgdown

[Bai-Li-NOAA]

Thank you, Kathryn. I plan to test the workflow on May 29.

[Bai-Li-NOAA]

Looks good to me. Thanks @k-doering-NOAA for setting up the reusable workflow. I successfully called it in FIMS.

Initially, the GHA failed when I broke the pkgdown build. Then the html was uploaded to the Actions page for successful runs.

I assume the failed checks on the pull request will run successfully after merging the changes into the main branch. I wonder if the errors from local checks can be resolved by writing custom expectations (e.g., expect_proj_file()). I've seen some examples in the {usethis} tests, but the utility functions for the active project seem very complicated.

[k-doering-NOAA]

Thanks @Bai-Li-NOAA , I just opened a new issue (#127 ) for your comment about the tests, which I think is a good point. We always expect the tests to fail for new actions on a feature branch and not yet merged into main using our current workflow, which is not helpful.