istacbaser - rostemplate project

[dieghernan]

https://github.com/orgs/rOpenSpain/projects

Dear developers,

I have created a fork including the deploy of your package on your gh-pages branch using the rostemplate (see Slack channel and https://ropenspain.github.io/rostemplate/). See a live preview of your pkgdown site here:
https://dieghernan.github.io/istacbaser/

An additional GitHub Action check-standard.yaml has been included. That action would check your package (AS CRAN) on several platforms on every push, pull request and every first day of the month. The goal is to provide CI on your package.

Actions on your package:

• Check locally and rebuild documentation (upgrade Roxygen version)

• The file name of your vignette has changed to the name of the package (https://pkgdown.r-lib.org/reference/build_articles.html?q=get%20started#get-started)

• Implementation of github-actions and related .gitgnore and .Rbuildignore

• cache.bak and cache.bak2 has been moved to data-raw to avoid a WARNING on check:

❯ checking contents of ‘data’ directory ... WARNING
109
  Files not of a type allowed in a ‘data’ directory:
110
    ‘cache.bak2’

Important - CI check fails on your package

The standard checks on your package sometimes fail due to an error on an API endpoint called on your vignette:

https://github.com/dieghernan/istacbaser/actions/runs/450354189

I was not able to reproduce the ERROR locally, as everything was OK, so I assume it is not due to a bad design of the code but to some random issues with the API provider.

Posible fix

An option for you is to exclude the vignette from the package itself, but keep it for your pkgdown site ( as done in https://github.com/rOpenSpain/mapSpain, accepted on CRAN). I created a specific branch with this fix here:

https://github.com/dieghernan/istacbaser/tree/fix

If you better prefer this approach let me know and I can expand the PR.

Next steps

You should receive a Pull Request with these modifications.

After your review and in case you consider merging, consider to deploy Github Pages on your settings (gh-pages branch).

Once it is done, I would appreciate if you move this issue to the Deployed tab on the Project panel (see also Projects tab on this website)

---

LOG

https://github.com/rOpenSpain/istacbaser

• @dieghernan reviewing

Fork: https://github.com/dieghernan/istacbaser
Live preview: https://dieghernan.github.io/istacbaser/

A WARNING was fixed

TODO: Open issue and pull request. Final deploy up to repo owner

CI/CD fails randomly due to API endpoint not reached on the vignette. Seems an API issue, not R package:

Workarounds:

• Ignore vignettes on R package (Available on web, avoid errors on checks) https://github.com/dieghernan/istacbaser/tree/fix
• Change vignette
• Reduce platforms on check

All options have drawbacks

[dieghernan]

#3