Automated creating github workflow files for countries

[joseph-palmer]

I noticed how often I forget to write the github yaml files so I've written code to automate it. Hopefully this will save both contributors and us some time.

This PR adds a test which checks there is a github yaml file for each country. If one is not found it creates it from a template with the correct countries details in.

Perhapse need to add a not on cran tag so it only get ran when running devtools::test()?

If approved we will need to update the wiki that users no longer need to add a file manually.

[github-actions[bot]]

👋 Thanks for opening this pull request! Can you please run through the following checklist before requesting review (ticking as complete or if not relevant).

• [x] Read our contribution guidelines if you have not already done so.
  • [x] If you have altered an existing class please run the tests locally (using devtools::load_all(); devtools::test()) first setting options(testDownload=TRUE, testSource=class-name) and report your findings.
  • [x] If you have added a new data class please run the tests locally for that class (using devtools::load_all(); devtools::test()).
  • [x] Check your code passes our CI checks and review any style and code coverage warnings.
  • [x] Comment with details if unable to get our CI checks to pass or unable to remove all warnings.

Thank you again for the contribution. If making large scale changes consider using our pre-commit hooks (see the contributing guide) to more easily comply with our guidelines.

[joseph-palmer]

This latest push adds a function make_new_data_source() which makes either a national or subnational class for a given source. So if you wanted to make a new country called Russia, you would call make_new_data_source("Russia") and it would make a template for Russia and make a github action file. You can also make a national data source by setting the type argument to national. This will replace DataClass with CountryDataClass in the inherits from section and change the family to national`.

The test is as before but no longer makes a github action file, just checks its there and tells the user how to make it if it throws an error. The issue is this will only work when running devtools::test() and not on check. This is because the .github files are not part of the R package, just the repo.

I can see two ways around this. 1) drop the test and instead make a github action that will do this check. 2) amend the test so it only runs when called with devtools::test() and not on check. I think solution 1 is better as it keeps repo stuff seperate from package stuff.

TODO before merging in:

• [x] Write github action to check the workflow file exists.
• [x] make sure the export tags are correct and stuff in correct places for build ignore (I always get confused with this)
• [x] Update wiki with outline of using this function when adding a new class.

[joseph-palmer]

Ive adde the github action to check for the yaml file. I did this by building the package and running a script in inst called test-github_workflow_present.R which I adapted from the previous test to throw an error with an informative message about the mising source. Not sure if this should be put in the .Rbuildignore.

This works but I have some what frankensteined this action together working from another action. If anyone more familiar with actions can suggests improvements I'd be very grateful :)

[RichardMN]

Sorry to arrive to the conversation late. I appreciate and agree with the usefulness of the idea of providing yaml files for the check. Could the check be something which is done in a workflow itself, possibly without even having an R script? This feels like something which doesn't need to get into R, or which might just use R to customize a template as necessary (if we can't find awk or sed).

[joseph-palmer]

github actions are not my strong point, this just worked but there is almost certainly a better way of writing this action, although I couldn't figure it out. If you can think of a better way please spawn a branch off of this one with the action for comparison and if happy we can merge into this :)