Add detailed project name requirements, mechanisms #16915
Merged
Conversation
This file contains 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
These changes reflect updated `docker compose` behavior regarding acceptable project names. compose-spec/compose-go#261 changed `docker compose` behavior to require normalized project names as input when using `-p`. Previously `docker compose` normalized project names automatically, leading to errors for some users after the change landed in compose-spec/compose-go v1.2.5 and docker/compose v2.5.1. compose-spec/compose-spec#314 updated the compose spec, effectively enforcing the same constraint for the `name:` config file property. compose-spec/compose-go#362 added information to the error message specifying the correct project name format. compose-spec/compose-go#364 added enforcement of the new project name requirements for all project name mechanisms (`-p`, `name:`, `COMPOSE_PROJECT_NAME`, project dir, working dir). Local development URLs: - http://localhost:4000/compose/reference/#use--p-to-specify-a-project-name - http://localhost:4000/compose/environment-variables/envvars/#compose_project_name - http://localhost:4000/engine/reference/commandline/compose/#use--p-to-specify-a-project-name Production URLs: - https://docs.docker.com/compose/reference/#use--p-to-specify-a-project-name - https://docs.docker.com/compose/environment-variables/envvars/#compose_project_name - https://docs.docker.com/engine/reference/commandline/compose/#use--p-to-specify-a-project-name Signed-off-by: Mike Bland <[email protected]>
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
glours
suggested changes
Mar 21, 2023
Comment on lines
66
to
80
| Each configuration has a project name. Compose sets the project name using | ||
| the following mechanisms, in order of precedence: | ||
|
|
||
| - The `-p` command line flag | ||
| - The `COMPOSE_PROJECT_NAME` environment variable | ||
| - The top level `name:` variable from the config file (or the last `name:` | ||
| from a series of config files specified using `-f`) | ||
| - The `basename` of the project directory containing the config file (or | ||
| containing the first config file specified using `-f`) | ||
| - The `basename` of the current directory if no config file is specified | ||
|
|
||
| Project names must contain only lowercase letters, decimal digits, dashes, | ||
| and underscores, and must begin with a lowercase letter or decimal digit. If | ||
| the `basename` of the project directory or current directory violates this | ||
| constraint, you must use one of the other mechanisms. |
There was a problem hiding this comment.
This file is generated from the upstream docker/compose repository, I opened a PR to report those changes directly in the reference documentation
This reverts part of commit 9ce29a8. As @glours noted in the review of docker#16915, this content comes from the upstream docker/compose repo. He's opened docker/compose#10390 to apply the update there instead. Signed-off-by: Mike Bland <[email protected]>
aevesdocker
approved these changes
Mar 22, 2023
|
@glours @aevesdocker Thanks! I see that the changes here have already landed in the production docs:
but that the changes from docker/compose#10390 haven't yet appeared at: Purely out of curiosity, how long before those changes propagate? And per @thaJeztah's observation in docker/compose#10390 (comment), I'm happy to create new PRs (if you prefer) to clarify the first part along the lines of: Compose sets the project name using the following mechanisms, in order of
precedence from highest to lowest:
- The `-p` or `--project-name` command line flag |
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.
Proposed changes
These changes reflect updated
docker composebehavior regarding acceptable project names.compose-spec/compose-go#261 changed
docker composebehavior to require normalized project names as input when using-p. Previouslydocker composenormalized project names automatically, leading to errors for some users after the change landed in compose-spec/compose-go v1.2.5 and docker/compose v2.5.1.compose-spec/compose-spec#314 updated the compose spec, effectively enforcing the same constraint for the
name:config file property. compose-spec/compose-go#362 added information to the error message specifying the correct project name format. compose-spec/compose-go#364 added enforcement of the new project name requirements for all project name mechanisms (-p,name:,COMPOSE_PROJECT_NAME, project dir, working dir).Local development URLs:
Production URLs:
Related issues (optional)
-p,name:config property compose-spec/compose-go#363cc: @ndeloof @laurazard @glours