update Docker workflow re. sandboxing (WIP)

Author: nuest

Dockerfile

@@ -1,5 +1,5 @@
 # Dockerfile to render the CODECHECK register, see https://github.com/codecheckers/register
-FROM rocker/verse:4.2
+FROM rocker/verse:4.5
 
 RUN apt-get update -qq && apt-get -y --no-install-recommends install \
   # needed for zen4R's dependency 'keyring'
@@ -16,9 +16,9 @@ WORKDIR /register
 ENTRYPOINT [ "R" ]
 
 # set R.cache path to avoid interactive prompt
-CMD [ "-e", "options(\"R.cache.rootPath\" = \"/tmp\"); codecheck::register_render(); sessionInfo(); warnings()'" ]
+CMD [ "-e", "sessionInfo(); options(\"R.cache.rootPath\" = \"/tmp\"); cat(\"GitHub API usage:\", toString(names(gh::gh_rate_limit())), \" : \", toString(gh::gh_rate_limit()), \"\\n\"); codecheck::register_render(); warnings()'" ]
 
-LABEL maintainer = "Daniel Nüst <daniel.nuest@tu-dresden.de>"
+LABEL maintainer="Daniel Nüst <daniel.nuest@tu-dresden.de>"
 
 # Usage, from local copy of the register repository
 # docker build --tag codecheckers-register .

Makefile

@@ -27,11 +27,16 @@ check_latest: clean
 
 # automated build is active via GitHub Action
 image_build:
-	docker build --tag codecheckers/register:latest --no-cache .
+	docker build --tag codecheckers/register:latest --no-cache --build-arg GITHUB_PAT=@bash -c "source ~/.Renviron && echo \$\$GITHUB_PAT" .
+
+# use the local GITHUB_PAT to avoid rate limits
+image_build_local: $(eval SHELL:=/bin/bash)
+	source ~/.Renviron && docker build --tag codecheckers/register:latest --no-cache --build-arg GITHUB_PAT=$$GITHUB_PAT .
+
 image_push: image_build
 	docker push codecheckers/register:latest
 .phony: image_build, image_push
 
-image_render:
+image_render: $(eval SHELL:=/bin/bash)
 	docker pull codecheckers/register:latest
-	docker run --rm -it --user rstudio -v $(shell pwd):/register codecheckers/register:latest
+	source ~/.Renviron && docker run --rm -it --user rstudio -v $(shell pwd):/register:rw -e GITHUB_PAT=$$GITHUB_PAT codecheckers/register:latest

README.md

@@ -79,6 +79,13 @@ and clear the cache (in case you made a recent change to an online repo) with `R
 To fix problems with hitting the GitHub API rate limit on local register management, go to [your PAT page](https://github.com/settings/tokens) and save a PAT in the environment variable `GITHUB_PAT` to the file `.Renviron` next to this README file.
 Alternatively, you may log into your GitHub account locally using the [GitHub CLI (`gh`)](https://cli.github.com/).
 
+To render the register manually in a local **Docker container**, you must mount a local `.Renviron` file with the `GITHUB_PAT` variable to not hit the GitHub API rate limit.
+Example (see also `Makefile`):
+
+```bash
+docker run --rm -it --user rstudio -v $PWD:/register:rw -v $HOME/.Renviron:/home/rstudio/.Renviron:ro codecheckers/register:latest
+```
+
 ## Editing of codecheck.yml files
 
 Copilot promts: