update -p project name flag documentation #10390
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
glours
requested review from
a team,
nicksieger,
ndeloof,
StefanScherer,
ulyssessouza,
milas and
laurazard
and removed request for
a team
glours
force-pushed
the
update-project-name-rules
branch
2 times, most recently
from
3038521
to
767ba37
Compare
mbland
added a commit
to mbland/docs
that referenced
this pull request
Mar 21, 2023
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 <mbland@acm.org>
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
glours
force-pushed
the
update-project-name-rules
branch
from
767ba37
to
20bfb9b
Compare
aevesdocker
pushed a commit
to docker/docs
that referenced
this pull request
Mar 22, 2023
* Add detailed project name requirements, mechanisms 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 <mbland@acm.org> * Revert _data/compose-cli/docker_compose.yaml This reverts part of commit 9ce29a8. As @glours noted in the review of #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 <mbland@acm.org> --------- Signed-off-by: Mike Bland <mbland@acm.org>
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## v2 #10390 +/- ##
=====================================
Coverage ? 59.99%
=====================================
Files ? 104
Lines ? 9008
Branches ? 0
=====================================
Hits ? 5404
Misses ? 3036
Partials ? 568 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
ndeloof
approved these changes
Mar 22, 2023
thaJeztah
reviewed
Mar 22, 2023
Comment on lines
+118
to
+120
| Each configuration has a project name. Compose sets the project name using | ||
| the following mechanisms, in order of precedence: | ||
| - The `-p` command line flag |
There was a problem hiding this comment.
I had to read twice to understand if the "order or precedence" here went from "lowest to highest" or vice-versa.
Perhaps @aevesdocker or @ChrisChinchilla have suggestions on better phrasing this section.
There was a problem hiding this comment.
Maybe also mention the long name of the flag in these
There was a problem hiding this comment.
I'd recommend:
Each configuration has a project name which Compose can set in different ways. The level of precedence (from highest to lowest) for each method is as follows:
This would match the docs
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.
What I did
Update the reference documentation of
-p/--project-nameattribute to detail the precedence mechanism used to setup the project name of a Compose stackRelated issue
docker/docs#16915
compose-spec/compose-spec#311
(not mandatory) A picture of a cute animal, if possible in relation to what you did
