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 infrastructure #55

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

florianm
Copy link
Collaborator

@florianm florianm commented Jan 1, 2024

  • Close Add infrastructure #53
  • Add devcontainer, vscode settings
  • Add pre-commit, disable invasive hooks, enable for devcontainer
  • Add pkgdown site, customise theme
  • Update DESCRIPTION
  • Add GPL-3 license
  • Add contributing guide
  • Add GH issue and pull request templates
  • Add GH actions for R CMD check, codecov, pkgdown
  • Add README.Rmd
  • Delete docs/, replaced by GH action pkgdown building and publishing the site to a separate branch and hosting via GH pages.
  • Delete travis CI, replaced by GH action R CMD check
  • Changes to existing codebase: comment out two tests that pass in codespaces but fail on Gh actions, format tests, remove obsolete lines from tests to resolve warnings, Roxygen-markdown converted some latex markup to markdown in function docstrings in R and man/.
  • NOTE: badges are formatted to the upstream repo carlopacioni/vortexr. They have been tested in the fork florianm/vortexr and might only start working upstream after merge and adding the carlopacioni/vortexr CODECOV_TOKEN.

Checks

The included new GitHub actions workflows can be reviewed in the WIP PR at florianm#1. This PR contains the same changes, but rebased for clarity and simplicity.

Actions after merge

These actions require admin access to carlopacioni/vortexr which currently only @carlopacioni has.

  • Enable codecov for carlopacioni/vortexr, add CODECOV_TOKEN as repository secret to carlopacioni/vortexr
  • Disable vortexr on TravisCI and readthedocs.
  • Enable the commented-out pre-commit hooks which will format and style the codebase. This will generate a lot of no-op changes which would look nicest in the git blame history if the author @carlopacioni did that himself.

* Add devcontainer, vscode settings
* Add pre-commit, disable invasive hooks, enable for devcontainer
* Add pkgdown site, customise theme
* Update DESCRIPTION
* Add GPL-3 license
* Add contributing guide
* Add GH issue and pull request templates
* Add GH actions for R CMD check, codecov, pkgdown
* Add README.Rmd
* Delete travis CI, replaced by GH action R CMD check
* TODO on merge: enable codecov for carlopacioni/vortexr, add CODECOV_TOKEN as repository secret to carlopacioni/vortexr
* Changes to existing codebase: comment out two tests that pass in codespaces but fail on Gh actions, format tests, remove obsolete lines from tests to resolve warnings
@florianm florianm added this to the Best practice milestone Jan 1, 2024
@florianm florianm self-assigned this Jan 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add infrastructure
1 participant