From dc90e533542f3f42357412569c7fcca1060a25cd Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 20 May 2026 18:13:38 +0000 Subject: [PATCH] Automated documentation update [skip ci] --- src/build-info/README.md | 25 +++++++++++++++++++++++++ src/renv-cache/README.md | 29 ++++------------------------- src/repos/README.md | 4 +++- src/utils/README.md | 26 ++++++++++++++++++++++++++ 4 files changed, 58 insertions(+), 26 deletions(-) create mode 100644 src/build-info/README.md create mode 100644 src/utils/README.md diff --git a/src/build-info/README.md b/src/build-info/README.md new file mode 100644 index 0000000..5268fe0 --- /dev/null +++ b/src/build-info/README.md @@ -0,0 +1,25 @@ + +# Container Metadata Injector (build-info) + +Bakes build-time release version and date metadata from GHA directly into a system-wide command. + +## Example Usage + +```json +"features": { + "ghcr.io/MiguelRodo/DevContainerFeatures/build-info:1": {} +} +``` + +## Options + +| Options Id | Description | Type | Default Value | +|-----|-----|-----|-----| +| version | The automated version number injected from the runner host environment. | string | development | +| buildDate | The build timestamp injected from the runner host environment. | string | unknown | + + + +--- + +_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/MiguelRodo/DevContainerFeatures/blob/main/src/build-info/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ diff --git a/src/renv-cache/README.md b/src/renv-cache/README.md index 8e743e7..7207c85 100644 --- a/src/renv-cache/README.md +++ b/src/renv-cache/README.md @@ -24,6 +24,10 @@ Configure R with renv cache | usePak | Whether to use `pak` for package installation. | boolean | false | | debug | Whether to print debug information during package restore. | boolean | false | | debugRenv | Whether to print debug information during renv restore. | boolean | false | +| repositories | Comma-separated list of GitHub repos to clone. Must support branch and profile syntax: user/repo@branch:profile. If :profile is omitted, it defaults to the root renv.lock. | string | - | +| pkg | Comma-separated list of specific packages to cache explicitly. | string | - | +| installSystemRequirements | Uses the Posit API to install apt-dependencies. | boolean | true | +| cranMirror | - | string | https://cloud.r-project.org | ## renv Global Cache Configuration @@ -155,31 +159,6 @@ You can place custom scripts in your renv subdirectories: These scripts receive the `pkgExclude` parameter and run in the project directory context. -### Accessing Lockfiles at Runtime - -The feature automatically creates snapshots of the `renv.lock` files used during the image build (both the "restore" state and the "update" state, if updates were requested). - -You can interact with these internal snapshots using the `renv-lockfile-cache` CLI utility, which is automatically available on your path inside the built container: - -**List Available Lockfiles:** -```bash -renv-lockfile-cache --list -``` - -**Copy a Lockfile to your Workspace:** -By default, the script will prefer the updated lockfile (if available) and will place it in your current directory: -```bash -renv-lockfile-cache --copy -``` - -You can also specify a custom path (either a directory or exact filename): -```bash -renv-lockfile-cache --copy ./my-project/ -renv-lockfile-cache --copy /workspaces/custom-name.lock -``` - -If multiple project configurations were used during the build, `--copy` will prompt you interactively to select which project's lockfile you want to extract. - ## Package Restoration This feature uses [`renvvv::renvvv_restore()`](https://github.com/MiguelRodo/renvvv) for package restoration instead of the default `renv::restore()`. This provides more robust restoration logic that: diff --git a/src/repos/README.md b/src/repos/README.md index 123acda..73e64c9 100644 --- a/src/repos/README.md +++ b/src/repos/README.md @@ -1,7 +1,9 @@ +### **IMPORTANT NOTE** +- **This Feature is deprecated, and will no longer receive any further updates/support.** # Automatically set up multi-repo projects (repos) -Installs the 'repos' CLI tool to manage multiple Git repositories. Optionally runs 'repos clone' when the container starts to clone repositories defined in repos.list. +(DEPRECATED: Use the 'utils' feature instead) Installs the 'repos' CLI tool to manage multiple Git repositories. Optionally runs 'repos clone' when the container starts to clone repositories defined in repos.list. ## Example Usage diff --git a/src/utils/README.md b/src/utils/README.md new file mode 100644 index 0000000..46b226a --- /dev/null +++ b/src/utils/README.md @@ -0,0 +1,26 @@ + +# MiguelRodo Utils (utils) + +Installs Miguel Rodo's utilities like 'repos' and 'setupmjr'. + +## Example Usage + +```json +"features": { + "ghcr.io/MiguelRodo/DevContainerFeatures/utils:1": {} +} +``` + +## Options + +| Options Id | Description | Type | Default Value | +|-----|-----|-----|-----| +| installRepos | Install the 'repos' utility. | boolean | true | +| installSetupmjr | Install the 'setupmjr' utility. | boolean | true | +| runOnStart | Automatically run 'repos clone' when the container starts (only applies if installRepos is true). | boolean | false | + + + +--- + +_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/MiguelRodo/DevContainerFeatures/blob/main/src/utils/devcontainer-feature.json). Add additional notes to a `NOTES.md`._