chore: Remove base-60 port quote warning from example compose.yaml
#3982
Conversation
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
This should not be relevant to users of `docker compose` which is the primary demographic.
|
That's a tough one. I always appreciate getting rid of old stuff that nobody uses anymore. In this case, I think it is warranted, too. I am just raising the concern that, in case we do see this issue popping back up, we should revert. |
georglauterbach
approved these changes
Apr 20, 2024
casperklein
approved these changes
Apr 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This should not be relevant to users of
docker composewhich is the primary demographic.However, I know that we have users with other compose clients that parse
compose.yamlwhere it may still be a gotcha, so feel free to reject this PR 👍Additional information
docker compose(v2) uses the v3 version ofgo-yamlfor parsing YAML where this gotcha will not occur. This package intentionally avoids base-60 syntax that we have raised awareness in our examplecompose.yaml. The Go rewrite ofdocker composedid not exist back when we added this AFAIK, and the earlier Python based version of Docker Compose was more prevalent (now EOL), which is where the bug was probably being encountered.It's worth noting that while base-60 syntax (aka sexagesimal) is valid for YAML 1.1, it's been removed with YAML 1.2 of the spec. YAML 1.2 spec was published in 2009Q3, so there's been adequate time for parsers in modern maintained software to update to that.
The last bug report to motivate the PR to add this warning comment was in March 2021, but the reporter did not provide much details about their environment. Presumably it'd be the fault of the YAML parser distributed with the
docker-compose(Python) package though 🤷♂️ (plus maintainers had confirmed it on their own systems). So 12 years roughly may not have been adequate time 😅The referenced compose spec still raises this awareness, which is fair as it's more generic towards implementers parsing YAML. It was added to the spec directly (Jan 2020) with many other changes and no PR process, no context provided.