SDK docs #13350
Merged
SDK docs #13350
+156
−0
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
Signed-off-by: Nicolas De Loof <[email protected]>
9 tasks
glours
approved these changes
Nov 6, 2025
Contributor
glours
left a comment
glours
left a comment
There was a problem hiding this comment.
Sounds good for now, let's see if we receive user feedbacks before adding more examples
aevesdocker
approved these changes
Nov 10, 2025
Contributor
There was a problem hiding this comment.
LGTM @ndeloof.
There are some non-urgent picky style guide nits that I can address in a follow-up (tried pushing to your branch but got a permission denied error).
When would you like me to add this to the docs repo?
tmeijn
pushed a commit
to tmeijn/dotfiles
that referenced
this pull request
Dec 12, 2025
⚠️ **CAUTION: this is a major update, indicating a breaking change!**⚠️ This MR contains the following updates: | Package | Update | Change | |---|---|---| | [docker/compose](https://github.com/docker/compose) | major | `v2.40.3` -> `v5.0.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>docker/compose (docker/compose)</summary> ### [`v5.0.0`](https://github.com/docker/compose/releases/tag/v5.0.0): "Mont Blanc" [Compare Source](docker/compose@v2.40.3...v5.0.0)  Major changes in this release: - Compose can now officially be used as a SDK to be integrated into third-party softwares - Internal builder has been removed, build is delegated to Docker Bake (same as `docker build` command) #### Why "v5" ? We decided to skip `3.0.0` for next major release after docker Compose v2 to prevent (more) confusion with the obsolete docker-compose file versions `2.x` and `3.x` inherited from Docker Compose v1. We also skipped `4.0.0` to have a clear separation with this legacy. #### What's Changed ##### ✨ Improvements - drop support for internal buildkit builder by [@​ndeloof](https://github.com/ndeloof) in [#​13056](docker/compose#13056) - Setup Compose service using functional parameters by [@​ndeloof](https://github.com/ndeloof) in [#​13312](docker/compose#13312) - Introduce abstractions to support SDK usage without requiring Docker CLI by [@​glours](https://github.com/glours) in [#​13313](docker/compose#13313) - configure Compose service with io.Reader and io.Writer by [@​glours](https://github.com/glours) in [#​13322](docker/compose#13322) - Make progress Writer a CLI component by [@​ndeloof](https://github.com/ndeloof) in [#​13316](docker/compose#13316) - SDK docs by [@​ndeloof](https://github.com/ndeloof) in [#​13350](docker/compose#13350) - document support for OCI and Git remote resources by [@​ndeloof](https://github.com/ndeloof) in [#​13362](docker/compose#13362) - run hooks on restart by [@​ndeloof](https://github.com/ndeloof) in [#​13321](docker/compose#13321) - fix(run): Ensure images exist only for the target service in run command by [@​idsulik](https://github.com/idsulik) in [#​13325](docker/compose#13325) - Add load project to api definition by [@​glours](https://github.com/glours) in [#​13329](docker/compose#13329) - introduce --insecure-registry, reserved for testing purpose by [@​ndeloof](https://github.com/ndeloof) in [#​13355](docker/compose#13355) - Move progress package to cmd as a command line component by [@​ndeloof](https://github.com/ndeloof) in [#​13357](docker/compose#13357) - Added support for `build.no_cache_filter` by [@​ndeloof](https://github.com/ndeloof) in [#​13377](docker/compose#13377) - add --wait option to start command by [@​ndeloof](https://github.com/ndeloof) in [#​13409](docker/compose#13409) ##### 🐛 Fixes - fix OCI compose override support by [@​ndeloof](https://github.com/ndeloof) in [#​13311](docker/compose#13311) - Fix help output for "exec --no-tty" option by [@​tonyo](https://github.com/tonyo) in [#​13314](docker/compose#13314) - fix typo in error message by [@​stasadev](https://github.com/stasadev) in [#​13328](docker/compose#13328) - disable progress UI when build is ran with --print by [@​ndeloof](https://github.com/ndeloof) in [#​13351](docker/compose#13351) - add (restore) support for detach keys by [@​ndeloof](https://github.com/ndeloof) in [#​13369](docker/compose#13369) - images command should display image Created time or N/A if not available by [@​ndeloof](https://github.com/ndeloof) in [#​13376](docker/compose#13376) - Fix support for port range by [@​ndeloof](https://github.com/ndeloof) in [#​13381](docker/compose#13381) - skip includes preparing publish by [@​ndeloof](https://github.com/ndeloof) in [#​13400](docker/compose#13400) - feat(model): ignore runtime flags in model configuration by [@​ilopezluna](https://github.com/ilopezluna) in [#​13404](docker/compose#13404) ##### 🔧 Internal - Next release will be major version v5.x by [@​ndeloof](https://github.com/ndeloof) in [#​13375](docker/compose#13375) - Test to check writeComposeFile detects invalid OCI artifact by [@​ndeloof](https://github.com/ndeloof) in [#​13309](docker/compose#13309) - Code Cleanup by [@​ndeloof](https://github.com/ndeloof) in [#​13315](docker/compose#13315) - fix various linting issues by [@​thaJeztah](https://github.com/thaJeztah) in [#​13326](docker/compose#13326) - Making the American/British spellings consistent to the error messages by [@​JLesDev](https://github.com/JLesDev) in [#​13366](docker/compose#13366) - gha: test against docker v29, v28, and rename checks to use `stable`, `oldstable` by [@​thaJeztah](https://github.com/thaJeztah) in [#​13380](docker/compose#13380) - refactor: replace Split in loops with more efficient SplitSeq by [@​vicerace](https://github.com/vicerace) in [#​13393](docker/compose#13393) - refactor: use strings.Builder to improve performance by [@​liuyueyangxmu](https://github.com/liuyueyangxmu) in [#​13398](docker/compose#13398) - Fix grammar: change 'adopted' to 'adopt' in Docker Swarm note by [@​rashmivagha](https://github.com/rashmivagha) in [#​13407](docker/compose#13407) - golangci-lint: use gci formatter instead of goimports by [@​thaJeztah](https://github.com/thaJeztah) in [#​13406](docker/compose#13406) - refactor: replace interface{} with any for clarity and modernization by [@​zjumathcode](https://github.com/zjumathcode) in [#​13411](docker/compose#13411) ##### ⚙️ Dependencies - Bump compose go to v2.10.0 by [@​ndeloof](https://github.com/ndeloof) in [#​13410](docker/compose#13410) - build(deps): bump github.com/containerd/platforms from 1.0.0-rc.1 to 1.0.0-rc.2 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​13353](docker/compose#13353) - build(deps): bump github.com/docker/docker from 28.5.1+incompatible to 28.5.2+incompatible by [@​dependabot](https://github.com/dependabot)\[bot] in [#​13361](docker/compose#13361) - build(deps): bump github.com/containerd/containerd/v2 from 2.1.4 to 2.2.0 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​13358](docker/compose#13358) - build(deps): bump github.com/docker/cli from 28.5.1+incompatible to 28.5.2+incompatible by [@​dependabot](https://github.com/dependabot)\[bot] in [#​13360](docker/compose#13360) - build(deps): bump golang.org/x/sys from 0.37.0 to 0.38.0 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​13367](docker/compose#13367) - build(deps): bump golang.org/x/sync from 0.17.0 to 0.18.0 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​13368](docker/compose#13368) - Dockerfile: update golangci-lint to v2.6.2 by [@​thaJeztah](https://github.com/thaJeztah) in [#​13370](docker/compose#13370) - build(deps): bump buildx v0.30.0, buildkit v0.26.0, otel v1.38.0, otel/contrib v0.63.0 by [@​thaJeztah](https://github.com/thaJeztah) in [#​13379](docker/compose#13379) - bump dependencies by [@​ndeloof](https://github.com/ndeloof) in [#​13392](docker/compose#13392) - build(deps): bump github.com/hashicorp/go-version from 1.7.0 to 1.8.0 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​13403](docker/compose#13403) - build(deps): bump golang.org/x/crypto v0.45.0 by [@​thaJeztah](https://github.com/thaJeztah) in [#​13405](docker/compose#13405) #### New Contributors - [@​tonyo](https://github.com/tonyo) made their first contribution in [#​13314](docker/compose#13314) - [@​stasadev](https://github.com/stasadev) made their first contribution in [#​13328](docker/compose#13328) - [@​JLesDev](https://github.com/JLesDev) made their first contribution in [#​13366](docker/compose#13366) - [@​vicerace](https://github.com/vicerace) made their first contribution in [#​13393](docker/compose#13393) - [@​liuyueyangxmu](https://github.com/liuyueyangxmu) made their first contribution in [#​13398](docker/compose#13398) - [@​ilopezluna](https://github.com/ilopezluna) made their first contribution in [#​13404](docker/compose#13404) - [@​rashmivagha](https://github.com/rashmivagha) made their first contribution in [#​13407](docker/compose#13407) - [@​zjumathcode](https://github.com/zjumathcode) made their first contribution in [#​13411](docker/compose#13411) **Full Changelog**: <docker/compose@v2.40.2...v5.0.0> </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0Mi4zMC40IiwidXBkYXRlZEluVmVyIjoiNDIuMzAuNCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiUmVub3ZhdGUgQm90Il19-->
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.
What I did
Related issue
#13230
(not mandatory) A picture of a cute animal, if possible in relation to what you did