Skip to content

docs: document Docker publish setup #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vycdev merged 1 commit into from
Aug 10, 2026
+12 −0
Merged

docs: document Docker publish setup #102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down