Merge pull request #217 from pharmaverse/automated-renv-lock-propagat…

…ion@devel Propagate renv.lock from pharmaverse/admiralci
pharmaverse · Dec 27, 2023 · 65f6117 · 65f6117
2 parents 8817555 + 2a70d73
commit 65f6117
Show file tree

Hide file tree

Showing 23 changed files with 1,693 additions and 866 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -32,4 +32,5 @@
 ^admiralvaccine\.Rcheck$
 ^admiralvaccine.*\.tar\.gz$
 ^admiralvaccine.*\.tgz$
+^\.devcontainer$
 ^doc$
diff --git a/.Rprofile b/.Rprofile
@@ -1,5 +1,47 @@
-if (Sys.getenv("GITHUB_ACTIONS") == "" || (Sys.getenv("GITHUB_ACTIONS") == "true" && getRversion()$major == 3 && getRversion()$minor == 6)) {
-  source("renv/activate.R")
+# Set renv profile base on R version.
+.get_dependencies <- function(project_dir) {
+  admdev_loc <- find.package("admiraldev", lib.loc = .libPaths(), quiet = TRUE)
+  adm_dev_suggests <- if (length(admdev_loc) != 0) {
+    renv:::renv_dependencies_discover_description(admdev_loc, fields = c("Depends", "Imports", "LinkingTo", "Suggests"))
+  } else {
+    data.frame(Packages = character(0))
+  }
+  suggests_packages <- renv:::renv_dependencies_discover_description(project_dir, fields = "Suggests")
+
+  packages <- names(
+    renv:::renv_package_dependencies(
+      unique(c(
+        project_dir,
+        adm_dev_suggests[["Package"]],
+        suggests_packages[["Package"]],
+        c("staged.dependencies", "renv", "styler")
+      ))
+    )
+  )
+  packages[!(packages %in% c("admiral", "admiraldev", "admiralci", "pharmaversesdtm", getwd()))]
+}
+
+options(renv.snapshot.filter = .get_dependencies)
+
+.renv_profile <- paste(R.version$major, substr(R.version$minor, 1, 1), sep = ".")
+if (!file.exists("./renv/profile")) {
+  if (.renv_profile %in% c("4.1", "4.2", "4.3")) {
+    message("Set renv profile to `", .renv_profile, "`")
+    Sys.setenv("RENV_PROFILE" = .renv_profile)
+  } else {
+    message("This repository do not contains the renv profile for your R version.")
+  }
 } else {
-  options(repos = c(CRAN = "https://cran.rstudio.com"))
+  message(
+    "Using renv profile from `renv/profile` file.\n",
+    "The `", readLines("./renv/profile"), "` profile will be used."
+  )
+}
+
+if (Sys.getenv("GITHUB_ACTIONS") != "") {
+  options(repos = c(CRAN = "https://packagemanager.posit.co/cran/latest"))
+  Sys.setenv("RENV_AUTOLOADER_ENABLED" = FALSE)
 }
+Sys.setenv("RENV_CONFIG_SANDBOX_ENABLED" = FALSE)
+Sys.setenv("RENV_CONFIG_AUTO_SNAPSHOT" = FALSE)
+source("renv/activate.R")
diff --git a/.devcontainer/4.1/devcontainer.json b/.devcontainer/4.1/devcontainer.json
@@ -0,0 +1,76 @@
+{
+	// https://containers.dev/implementors/json_reference/
+	"name": "Admiral R-4.1 (RStudio) container",
+	"image": "ghcr.io/pharmaverse/admiralci-4.1:latest",
+	// Install Dev Container Features. More info: https://containers.dev/features
+	"containerEnv": {
+		"ROOT": "true",
+		"PASSWORD": "rstudio",
+		"DISABLE_AUTH": "true",
+		"RENV_AUTOLOADER_ENABLED": "false"
+	},
+	"features": {
+		"ghcr.io/rocker-org/devcontainer-features/r-rig:1": {
+			"version": "none",
+			"vscodeRSupport": "full",
+			"installRadian": true,
+			"installVscDebugger": true
+		},
+		"ghcr.io/rocker-org/devcontainer-features/renv-cache:latest": {},
+		"ghcr.io/devcontainers/features/common-utils:2": {
+			"installZsh": true,
+			"configureZshAsDefaultShell": false,
+			"installOhMyZsh": true,
+			"username": "rstudio",
+			"upgradePackages": false
+		},
+		"ghcr.io/mikaello/devcontainer-features/modern-shell-utils:1": {}
+	},
+	"init": true,
+	"overrideCommand": false,
+
+	"postCreateCommand": "bash ./.devcontainer/postCreateCommand.sh",
+
+	"postAttachCommand": "$BROWSER \"https://${CODESPACE_NAME}-8787.${GITHUB_CODESPACES_PORT_FORWARDING_DOMAIN}/\"; echo 'To open rstudio in your browser, just type rstudio in the terminal'",
+
+	"customizations": {
+		"vscode": {
+			"settings": {
+				"r.rterm.linux": "/usr/local/bin/radian",
+				"r.bracketedPaste": true,
+				"editor.bracketPairColorization.enabled": true, 
+				"editor.guides.bracketPairs": "active"
+			},
+			"extensions": [
+				"vsls-contrib.codetour",
+				"GitHub.copilot",
+				"GitHub.copilot-chat",
+				// R extensions
+				"ikuyadeu.r",
+				"REditorSupport.r-lsp",
+				// Extra extension
+				"streetsidesoftware.code-spell-checker",
+				"eamodio.gitlens",
+				"cweijan.vscode-office",
+				"donjayamanne.githistory",
+				"GitHub.vscode-github-actions",
+				"GitHub.vscode-pull-request-github",
+				"GitHub.remotehub",
+				"alefragnani.Bookmarks",
+				"vscode-icons-team.vscode-icons"
+			]
+		}
+	},
+
+	// RStudio ports
+	"forwardPorts": [8787],
+	"portsAttributes": {
+		"8787": {
+			"label": "Rstudio",
+			"requireLocalPort": true,
+			"onAutoForward": "openBrowser"
+		}
+	},
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root
+	"remoteUser": "rstudio"
+}
diff --git a/.devcontainer/4.2/devcontainer.json b/.devcontainer/4.2/devcontainer.json
@@ -0,0 +1,76 @@
+{
+	// https://containers.dev/implementors/json_reference/
+	"name": "Admiral R-4.2 (RStudio) container",
+	"image": "ghcr.io/pharmaverse/admiralci-4.2:latest",
+	// Install Dev Container Features. More info: https://containers.dev/features
+	"containerEnv": {
+		"ROOT": "true",
+		"PASSWORD": "rstudio",
+		"DISABLE_AUTH": "true",
+		"RENV_AUTOLOADER_ENABLED": "false"
+	},
+	"features": {
+		"ghcr.io/rocker-org/devcontainer-features/r-rig:1": {
+			"version": "none",
+			"vscodeRSupport": "full",
+			"installRadian": true,
+			"installVscDebugger": true
+		},
+		"ghcr.io/rocker-org/devcontainer-features/renv-cache:latest": {},
+		"ghcr.io/devcontainers/features/common-utils:2": {
+			"installZsh": true,
+			"configureZshAsDefaultShell": false,
+			"installOhMyZsh": true,
+			"username": "rstudio",
+			"upgradePackages": false
+		},
+		"ghcr.io/mikaello/devcontainer-features/modern-shell-utils:1": {}
+	},
+	"init": true,
+	"overrideCommand": false,
+
+	"postCreateCommand": "bash ./.devcontainer/postCreateCommand.sh",
+
+	"postAttachCommand": "$BROWSER \"https://${CODESPACE_NAME}-8787.${GITHUB_CODESPACES_PORT_FORWARDING_DOMAIN}/\"; echo 'To open rstudio in your browser, just type rstudio in the terminal'",
+
+	"customizations": {
+		"vscode": {
+			"settings": {
+				"r.rterm.linux": "/usr/local/bin/radian",
+				"r.bracketedPaste": true,
+				"editor.bracketPairColorization.enabled": true, 
+				"editor.guides.bracketPairs": "active"
+			},
+			"extensions": [
+				"vsls-contrib.codetour",
+				"GitHub.copilot",
+				"GitHub.copilot-chat",
+				// R extensions
+				"ikuyadeu.r",
+				"REditorSupport.r-lsp",
+				// Extra extension
+				"streetsidesoftware.code-spell-checker",
+				"eamodio.gitlens",
+				"cweijan.vscode-office",
+				"donjayamanne.githistory",
+				"GitHub.vscode-github-actions",
+				"GitHub.vscode-pull-request-github",
+				"GitHub.remotehub",
+				"alefragnani.Bookmarks",
+				"vscode-icons-team.vscode-icons"
+			]
+		}
+	},
+
+	// RStudio ports
+	"forwardPorts": [8787],
+	"portsAttributes": {
+		"8787": {
+			"label": "Rstudio",
+			"requireLocalPort": true,
+			"onAutoForward": "openBrowser"
+		}
+	},
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root
+	"remoteUser": "rstudio"
+}
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -0,0 +1,76 @@
+{
+	// https://containers.dev/implementors/json_reference/
+	"name": "Admiral R-4.3 (RStudio) container",
+	"image": "ghcr.io/pharmaverse/admiralci-4.3:latest",
+	// Install Dev Container Features. More info: https://containers.dev/features
+	"containerEnv": {
+		"ROOT": "true",
+		"PASSWORD": "rstudio",
+		"DISABLE_AUTH": "true",
+		"RENV_AUTOLOADER_ENABLED": "false"
+	},
+	"features": {
+		"ghcr.io/rocker-org/devcontainer-features/r-rig:1": {
+			"version": "none",
+			"vscodeRSupport": "full",
+			"installRadian": true,
+			"installVscDebugger": true
+		},
+		"ghcr.io/rocker-org/devcontainer-features/renv-cache:latest": {},
+		"ghcr.io/devcontainers/features/common-utils:2": {
+			"installZsh": true,
+			"configureZshAsDefaultShell": false,
+			"installOhMyZsh": true,
+			"username": "rstudio",
+			"upgradePackages": false
+		},
+		"ghcr.io/mikaello/devcontainer-features/modern-shell-utils:1": {}
+	},
+	"init": true,
+	"overrideCommand": false,
+
+	"postCreateCommand": "bash ./.devcontainer/postCreateCommand.sh",
+
+	"postAttachCommand": "$BROWSER \"https://${CODESPACE_NAME}-8787.${GITHUB_CODESPACES_PORT_FORWARDING_DOMAIN}/\"; echo 'To open rstudio in your browser, just type rstudio in the terminal'",
+
+	"customizations": {
+		"vscode": {
+			"settings": {
+				"r.rterm.linux": "/usr/local/bin/radian",
+				"r.bracketedPaste": true,
+				"editor.bracketPairColorization.enabled": true, 
+				"editor.guides.bracketPairs": "active"
+			},
+			"extensions": [
+				"vsls-contrib.codetour",
+				"GitHub.copilot",
+				"GitHub.copilot-chat",
+				// R extensions
+				"ikuyadeu.r",
+				"REditorSupport.r-lsp",
+				// Extra extension
+				"streetsidesoftware.code-spell-checker",
+				"eamodio.gitlens",
+				"cweijan.vscode-office",
+				"donjayamanne.githistory",
+				"GitHub.vscode-github-actions",
+				"GitHub.vscode-pull-request-github",
+				"GitHub.remotehub",
+				"alefragnani.Bookmarks",
+				"vscode-icons-team.vscode-icons"
+			]
+		}
+	},
+
+	// RStudio ports
+	"forwardPorts": [8787],
+	"portsAttributes": {
+		"8787": {
+			"label": "Rstudio",
+			"requireLocalPort": true,
+			"onAutoForward": "openBrowser"
+		}
+	},
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root
+	"remoteUser": "rstudio"
+}
diff --git a/.devcontainer/postCreateCommand.sh b/.devcontainer/postCreateCommand.sh
@@ -0,0 +1,11 @@
+#!/bin/bash
+
+# move script rstudio into /usr/bin
+sudo cp "$(pwd)/.devcontainer/rstudio.sh" /usr/bin/rstudio
+sudo chmod +x /usr/bin/rstudio
+
+# Restore renv and install staged dependencies
+R -q -e 'renv::restore(lockfile = file.path("renv", "profiles", paste(R.version$major, substr(R.version$minor, 1, 1), sep = "."), "renv.lock")); staged.dependencies::install_deps(staged.dependencies::dependency_table(project = ".", verbose = 1), verbose = 1);'
+
+# Define rstudio default working directory
+jq --arg folder "$(pwd)/" '. + { "initial_working_directory": $folder }' .devcontainer/rstudio-prefs.json > ~/.config/rstudio/rstudio-prefs.json
diff --git a/.devcontainer/rstudio-prefs.json b/.devcontainer/rstudio-prefs.json
@@ -0,0 +1,8 @@
+{
+	"save_workspace": "never",
+	"always_save_history": false,
+	"reuse_sessions_for_project_links": true,
+	"posix_terminal_shell": "bash",
+	"initial_working_directory": "/workspaces",
+	"show_hidden_files": true
+}
diff --git a/.devcontainer/rstudio.sh b/.devcontainer/rstudio.sh
@@ -0,0 +1,5 @@
+#!/bin/bash
+
+$BROWSER "https://${CODESPACE_NAME}-8787.${GITHUB_CODESPACES_PORT_FORWARDING_DOMAIN}"
+
+exit 1
diff --git a/.github/workflows/common.yml b/.github/workflows/common.yml
@@ -13,15 +13,13 @@ on:
   push:
     branches:
       - main
-      - devel
       - pre-release
       - test
   # 'pull_request' events are triggered when PRs are
   # created against one of these target branches.
   pull_request:
     branches:
       - main
-      - devel
       - pre-release
       - test
   # 'release' events are triggered when...
@@ -37,7 +35,7 @@ concurrency:
 
 env:
   R_VERSION: "4.1"
-  
+
 jobs:
   get_r_version:
     name: Get R version
@@ -81,6 +79,8 @@ jobs:
     name: Check
     uses: pharmaverse/admiralci/.github/workflows/r-cmd-check.yml@main
     if: github.event_name == 'pull_request'
+    with:
+      error-on: warning # TODO: find a way to ignore specific notes
   docs:
     name: Documentation
     uses: pharmaverse/admiralci/.github/workflows/pkgdown.yml@main
@@ -91,7 +91,7 @@ jobs:
       # Whether to skip multiversion docs
       # Note that if you have multiple versions of docs,
       # your URL links are likely to break due to path changes
-      skip-multiversion-docs: false
+      skip-multiversion-docs: true
   linter:
     name: Lint
     uses: pharmaverse/admiralci/.github/workflows/lintr.yml@main
@@ -130,4 +130,4 @@ jobs:
     if: github.event_name == 'pull_request'
     needs: get_r_version
     with:
-      r-version: "${{ needs.get_r_version.outputs.r-version }}"
+      r-version: "${{ needs.get_r_version.outputs.r-version }}"