From b5386c82ba3dbda7a9ac9d3550349384595afebb Mon Sep 17 00:00:00 2001 From: vycdev2 Date: Sun, 9 Aug 2026 18:04:09 +0000 Subject: [PATCH] docs: document Docker publish setup --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fe2a2f5..ac60ec8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,6 +25,18 @@ Install dotnet-ef (if needed): dotnet tool install --global dotnet-ef ``` +## Publishing the Docker image + +The publishing script reads registry credentials and image settings from `publish/.env`, which is intentionally ignored by Git. Create it from the checked-in template before publishing: + +```powershell +Copy-Item .\publish\default.env .\publish\.env +# Replace the placeholder values in publish\.env, then run: +pwsh .\publish\publish.ps1 +``` + +Keep `publish/.env` untracked because it contains registry credentials. Publishing also requires PowerShell and a running Docker daemon. + ## Running the command list generator This repository includes a small Python script that extracts command metadata from the C# modules and writes `COMMANDS.md`.