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

Add GitHub actions #81

Merged
merged 2 commits into from
Jun 1, 2024
Merged

Add GitHub actions #81

merged 2 commits into from
Jun 1, 2024

Conversation

cjrace
Copy link
Collaborator

@cjrace cjrace commented May 28, 2024

Added two GitHub actions files:

  1. Standard package checks

This was done using usethis::use_github_action("check-standard"), and adds R CMD checks against a number of operating systems for the package.

This added a status badge to the readme too as a bonus 🦡

Have set to run against all pushes and PRs to main/master (default) and also any PRs to our working branches (development / update-to-gds-v5.4).

More information on these checks can be found at - https://r-pkgs.org/r-cmd-check.html. Effectively it's similar to running devtools::check() locally.

  1. Build pkgdown site

Realised the current docs aren't hosted anywhere, so added a workflow that we can test when we do merge to main to add in the documentation onto a github pages site.

You can preview the site using devtools::build_site() though be aware it generates a bunch of updates to files in the docs/ folder. Try to avoid committing any of these, as ultimately we want to ignore them. I've raised #80 for me to remember to check this and do clean up of the Git history afterwards, which will stop this happening in the long run.

@cjrace cjrace requested a review from sarahmwong May 28, 2024 13:39
Copy link
Collaborator

@sarahmwong sarahmwong left a comment

Choose a reason for hiding this comment

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

Cheers Cam this is really cool! Didn't know it was so simple to have the pkgdown site build from the documentation - also yay for badges (and zooming in like 200x to find that it was a badger and not a mole emoji)

@sarahmwong
Copy link
Collaborator

I'll assign the rest of the issues in our checklist once you've merged in :)

@cjrace cjrace merged commit 068997a into update-to-gds-v5.4 Jun 1, 2024
5 checks passed
@cjrace cjrace deleted the add-github-actions branch June 1, 2024 09:55
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.

2 participants