-
Notifications
You must be signed in to change notification settings - Fork 792
On branch main #1008
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.
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
On branch main #1008
Conversation
Your branch is up to date with 'origin/main'. Changes to be committed: new file: CLAUDE.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds comprehensive documentation for the Discourse Docker deployment system by introducing a new CLAUDE.md file. This documentation provides guidance to Claude Code when working with the repository.
- Introduces detailed architecture documentation covering the launcher script, templates, and Docker images
- Provides developer guidance for common tasks like building images, testing, and troubleshooting
- Documents system constraints, environment variables, and deployment patterns
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
- `redis.yml` - Standalone Redis container | ||
- `/templates/` - pups-managed YAML templates that are composed into containers: | ||
- `postgres.template.yml` - PostgreSQL (current stable version) | ||
- `postgres.{15,13,12,10,9.5}.template.yml` - Specific PostgreSQL versions |
Copilot
AI
Oct 8, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] The PostgreSQL version list may become outdated quickly. Consider using a more generic description like 'postgres.{version}.template.yml - Version-specific PostgreSQL configurations' to avoid maintenance burden of keeping specific version numbers current.
- `postgres.{15,13,12,10,9.5}.template.yml` - Specific PostgreSQL versions | |
- `postgres.{version}.template.yml` - Version-specific PostgreSQL configurations |
Copilot uses AI. Check for mistakes.
|
||
### Bundled Plugins | ||
|
||
The launcher script defines `BUNDLED_PLUGINS` array (line 26-59) containing official Discourse plugins that can be installed via the docker_manager. |
Copilot
AI
Oct 8, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hard-coded line numbers (26-59) will become incorrect when the launcher script is modified. Consider removing specific line numbers or using a more general reference to avoid maintenance issues.
The launcher script defines `BUNDLED_PLUGINS` array (line 26-59) containing official Discourse plugins that can be installed via the docker_manager. | |
The launcher script defines a `BUNDLED_PLUGINS` array containing official Discourse plugins that can be installed via the docker_manager. |
Copilot uses AI. Check for mistakes.
|
||
- Default: Uses `version: latest` to pull latest Discourse version | ||
- Can pin to specific version: `version: v3.1.0` in container params | ||
- Base image version specified in `web.template.yml` (e.g., `discourse/base:2.0.20251003-1437`) |
Copilot
AI
Oct 8, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] The specific base image version example '2.0.20251003-1437' will become outdated. Consider using a more generic example format like 'discourse/base:X.Y.YYYYMMDD-HHMM' to illustrate the versioning pattern without referencing a specific version.
- Base image version specified in `web.template.yml` (e.g., `discourse/base:2.0.20251003-1437`) | |
- Base image version specified in `web.template.yml` (e.g., `discourse/base:X.Y.YYYYMMDD-HHMM`) |
Copilot uses AI. Check for mistakes.
Your branch is up to date with 'origin/main'.
Changes to be committed:
new file: CLAUDE.md