Repository navigation
Conversation
Without a hostname, Docker uses the container ID, which shows up in the
`ddev ssh -s <service>` prompt. DDEV sets hostname on its own services.
- docker-compose.addon-template.yaml: set
`hostname: ${DDEV_SITENAME}-addon-template`, and add an `x-ddev` block
with `ssh-shell: bash` (the default for custom services is `sh`) plus
commented `describe-info` and `describe-url-port` examples.
- README_ADDON.md: add `ddev ssh -s addon-template` to the usage table.
- update-checker.sh: report compose files that set `container_name:`
without a matching `hostname:`.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
DDEV will set hostname for add-on services itself, see ddev/ddev#8983, so the template and the update checker don't need to handle it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
rfay
changed the title
ssh-shell depends on the image, so leave it for the maintainer to enable. Show every x-ddev key in DDEV HEAD, noting the DDEV version each newer one needs. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
rfay
changed the title
Member
Author
|
Removed the |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Short Summary (TL;DR)
The template service now has a commented-out
x-ddevblock that shows every key DDEV supports, and the README showsddev ssh -s addon-template.The Issue
The template didn't show the
x-ddevextension, so add-on maintainers had to find it in the docs.This came up in ddev/ddev-selenium-standalone-chrome#99, along with the container ID showing up as the hostname in the
ddev ssh -s <service>prompt. This PR doesn't sethostname:: DDEV will set it for add-on services itself in ddev/ddev#8983.How This PR Solves The Issue
docker-compose.addon-template.yaml: a commented-outx-ddevblock with a link to the docs and an example for each key:ssh-shell,describe-info,describe-url-port: DDEV v1.24.9+, so they work with the template's>= v1.24.10constraint.omit-ddev-labels: noted as requiring DDEV v1.25.3+.container-user,pull-images: noted as requiring DDEV v1.25.5+ (not released yet).Everything is commented out because each key depends on the add-on. For example,
ssh-shell: bashonly works if the image includes bash.README_ADDON.md: addev ssh -s addon-templaterow in the usage table.Manual Testing Instructions
ddev add-on get ddev/ddev-addon-template --pr 120 ddev restart ddev ssh -s addon-template # opens sh, since x-ddev is commented outUncomment
x-ddev:andssh-shell: bashin.ddev/docker-compose.addon-template.yaml, then:Automated Testing Overview
No new bats tests. The compose change is comments only.
Release/Deployment Notes
None.
🤖 Generated with Claude Code