document project atlas deploy key

2026-07-28 23:06:19 -07:00
parent 0d34b35e08
commit 89a180faf3
2 changed files with 6 additions and 0 deletions
@@ -7,6 +7,8 @@ submodule_path="${PROJECT_ATLAS_SUBMODULE_PATH:-portal/src/data/project-atlas}"
 ssh_key="${PROJECT_ATLAS_SSH_PRIVATE_KEY:-}"
 key_file="${RUNNER_TEMP:-/tmp}/project-atlas-submodule-key"

+# The Project Atlas submodule lives in Gitea and must be fetched with a
+# read-only deploy key stored in PROJECT_ATLAS_SSH_PRIVATE_KEY.
 if git -C "$repo_root" submodule status -- "$submodule_path" | grep -q '^-'; then
  if [[ -z "$ssh_key" ]]; then
    echo "PROJECT_ATLAS_SSH_PRIVATE_KEY is required to initialize the private projectAtlas submodule." >&2