docs: add log volume mount to Docker dev examples in CONTRIBUTING.md by Copilot · Pull Request #8501 · github/gh-aw-mcpg · GitHub
Skip to content

docs: add log volume mount to Docker dev examples in CONTRIBUTING.md#8501

Merged
lpcox merged 2 commits into
mainfrom
copilot/update-contributing-md-log-volume
Jul 2, 2026
Merged

docs: add log volume mount to Docker dev examples in CONTRIBUTING.md#8501
lpcox merged 2 commits into
mainfrom
copilot/update-contributing-md-log-volume

Conversation

Copilot AI commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

The Docker run examples in CONTRIBUTING.md omitted the log directory volume mount, meaning developers following those commands would lose all logs when the container exits — complicating troubleshooting.

Changes

  • CONTRIBUTING.md › "Run Container" — added -v /path/to/logs:/tmp/gh-aw/mcp-logs
  • CONTRIBUTING.md › "Override with custom configuration" — same mount added for consistency
docker run --rm -i \
  -e MCP_GATEWAY_PORT=8000 \
  -e MCP_GATEWAY_DOMAIN=localhost \
  -e MCP_GATEWAY_AGENT_ID=your-agent-id \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v /path/to/logs:/tmp/gh-aw/mcp-logs \
  -p 8000:8000 \
  awmg < config.json

Aligns with the README.md Quick Start and avoids the warning emitted by run_containerized.sh's validate_log_directory_mount() when the log path isn't mounted.

Copilot AI linked an issue Jul 2, 2026 that may be closed by this pull request
GitHub Advanced Security started work on behalf of lpcox July 2, 2026 22:30 View session
GitHub Advanced Security finished work on behalf of lpcox July 2, 2026 22:31
Copilot AI changed the title [WIP] Update log volume mount in CONTRIBUTING.md docs: add log volume mount to Docker dev examples in CONTRIBUTING.md Jul 2, 2026
Copilot finished work on behalf of lpcox July 2, 2026 22:32
Copilot AI requested a review from lpcox July 2, 2026 22:32
@lpcox lpcox marked this pull request as ready for review July 2, 2026 22:36
Copilot AI review requested due to automatic review settings July 2, 2026 22:36

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Docker development examples in CONTRIBUTING.md to persist gateway logs outside the container by adding the default log directory volume mount, aligning the contributing guide with the documented container entrypoint behavior (run_containerized.sh) and the README quick start.

Changes:

  • Added -v /path/to/logs:/tmp/gh-aw/mcp-logs to the “Run Container” example.
  • Added the same log volume mount to the “Override with custom configuration” example for consistency.
Show a summary per file
File Description
CONTRIBUTING.md Adds the default log directory volume mount to Docker run examples so logs persist after container exit.

Review details

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 1/1 changed files
  • Comments generated: 0
  • Review effort level: Low

GitHub Advanced Security started work on behalf of lpcox July 2, 2026 22:38 View session
GitHub Advanced Security finished work on behalf of lpcox July 2, 2026 22:38
@lpcox lpcox merged commit 6b71b65 into main Jul 2, 2026
39 checks passed
@lpcox lpcox deleted the copilot/update-contributing-md-log-volume branch July 2, 2026 22:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

📚 Documentation Reconciliation Report - 2026-07-01

3 participants