Merge pull request #167 from miraisolutions/feature/devcontainer-upda…

…te-and-readme

devcontainer update and readme, as well as NEWS.

.Rbuildignore

@@ -67,3 +67,4 @@ cran-comments.md
 revdep/
 .github/
 .devcontainer/
+^revdep$

.devcontainer/Dockerfile

@@ -3,7 +3,9 @@ FROM rocker/verse:devel
 RUN apt-get update
 RUN apt-get install -y libxml2-dev libssl-dev gpg
 # texlive
-RUN apt-get install -y libqpdf26 qpdf ghostscript
+RUN apt-get install -y libqpdf28 qpdf ghostscript
+# RUN tlmgr install xcolor # (more latex libs would be required to include pdf related checks)
 RUN install2.r --error devtools rJava RUnit zoo qpdf languageserver
+RUN installGithub.r r-lib/revdepcheck
 RUN apt-get install -y pandoc
 RUN install2.r --error ggplot2

.devcontainer/README.md

@@ -0,0 +1,20 @@
+# Purpose of the devcontainer
+
+This devcontainer uses a `Dockerfile` and supports the development of XLConnect with VS Code, see also the [documentation related to devcontainers](https://microsoft.github.io/code-with-engineering-playbook/developer-experience/devcontainers/).
+
+
+## How to use the devcontainer
+
+It is recommended to open the XLConnect project in VS Code, as it provides some useful features to work with devcontainers.
+
+The `Dockerfile` will sometimes require updates and it is currently not intended to check vignettes or manual. If we wanted to check that as well, we would first need to install all the required latex packages (see commented out line in `Dockerfile`).
+
+`devcontainer.json` allows to configure the devcontainer (see file and linked resources there).
+
+## Concrete steps to run the checks
+
+0. (Required only once) Checkout and open the XLConnect repo in VS Code. It is recommended to use a separate checkout folder from the XLConnect project opened in RStudio.
+1. Switch to the desired branch and open the container (VS Code should have pop up dialogs for that).
+2. Open the container (I use `File > Open Recent` to switch between repo and container). It may need to re-build the image, in which case there is no prompt like `root@9348tzh4o:/workspaces/xlconnect#`. I just open the repo and then the container again to get that prompt, which allows interacting with the container and running the actual commands.
+3. Run `R CMD build . --no-build-vignettes` to build XLConnect locally and run `R CMD check XLConnect_<version>.tar.gz --ignore-vignettes --no-manual` to check the package (`<version>` varies).
+4. Open an R session (using `R`) and if required initialize the reverse depencency check with `usethis::use_revdep()`. Run the actual checks with `revdepcheck::revdep_check(num_workers = 8, timeout = as.difftime(120, units = "mins"))` and use `revdepcheck::revdep_reset()` first in order to run it again.

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: XLConnect
 Type: Package
 Title: Excel Connector for R
-Version: 1.0.6.9999
+Version: 1.0.6
 Authors@R: c(person("Mirai Solutions GmbH", role = "aut",
  email = "[email protected]"),
  person("Martin", "Studer", role = "cre",

NEWS

@@ -1,11 +1,13 @@
 XLConnect News
 --------------
 
-1.0.6 ???
+1.0.6 2022-10-04
  * Fix building of vignettes (#154)
  * Fix java version parsing (#156)
  * Remove java version compatibility upper limit (#165)
  * upgrade to POI 5.2.3 (#168)
+ * Fix setForceFormulaRecalculation / getForceFormulaRecalculation for R >= 4.2.0 (#170)
+ * Add overwriteFormulaCells parameter to writeNamedRegion, appendNamedRegion, writeWorkSheet (#173)
 
 1.0.5 2021-09-30
  * Support java 17

cran-comments.md

@@ -23,4 +23,4 @@ Justification: XLConnect uses a java component which we maintain in a separate p
 
 # Downstream dependencies
 
-_revdepcheck_ found 10 downstream dependencies; they were all checked successfully.
+_revdepcheck_ found 7 downstream dependencies; they were all checked successfully.