Skip to content

docs: Add note about unsupported BuildKit Dockerfile features#1696

Merged
HofmeisterAn merged 2 commits into
developfrom
feature/update-buildkit-docs
May 29, 2026
Merged

docs: Add note about unsupported BuildKit Dockerfile features#1696
HofmeisterAn merged 2 commits into
developfrom
feature/update-buildkit-docs

Conversation

@HofmeisterAn

@HofmeisterAn HofmeisterAn commented May 29, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Collaborator

What does this PR do?

The PR documents that BuildKit features are not supported by the Testcontainers image builder because the Docker Engine API does not support them.

Why is it important?

-

Related issues

Summary by CodeRabbit

  • Documentation
    • Added warning note clarifying that Testcontainers' .NET Docker image builder API does not support Docker BuildKit features via the Docker Engine API, with details on incompatible Dockerfile instructions and options.

Review Change Stack

@HofmeisterAn
HofmeisterAn requested a review from a team as a code owner May 29, 2026 05:22
@HofmeisterAn HofmeisterAn added the documentation Docs, docs, docs. label May 29, 2026
@netlify

netlify Bot commented May 29, 2026 •
edited
Loading

Copy link
Copy Markdown

✅ Deploy Preview for testcontainers-dotnet ready!

Name Link
🔨 Latest commit c3e392c
🔍 Latest deploy log https://app.netlify.com/projects/testcontainers-dotnet/deploys/6a1922897445400008110df1
😎 Deploy Preview https://deploy-preview-1696--testcontainers-dotnet.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented May 29, 2026 •
edited
Loading

Copy link
Copy Markdown

Walkthrough

This PR adds a warning callout to the Docker image builder API documentation explaining that BuildKit features are not supported when using Testcontainers' .NET image builder API via the Docker Engine API, making BuildKit-dependent Dockerfile instructions unavailable.

Changes

BuildKit Limitations Documentation

Layer / File(s) Summary
BuildKit limitations warning
docs/api/create_docker_image.md		 A warning callout clarifies that the Docker image builder API does not support BuildKit features through the Docker Engine API, with a reference link for additional context.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A warning, clear and bright,
BuildKit dreams take flight—
But through the Engine's gates, alas,
They cannot pass, cannot pass.
So we document the bounds,
Where Docker's magic makes its rounds! 📚✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The PR description covers the main sections but 'Why is it important?' section is left empty with just a dash, reducing the clarity of the rationale.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title accurately describes the main change: adding documentation about unsupported BuildKit Dockerfile features in the Testcontainers .NET API.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/update-buildkit-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@HofmeisterAn HofmeisterAn changed the title Feature/update buildkit docs docs: Add note about unsupported BuildKit Dockerfile features May 29, 2026
@HofmeisterAn
HofmeisterAn merged commit 571c175 into develop May 29, 2026
82 checks passed
@HofmeisterAn
HofmeisterAn deleted the feature/update-buildkit-docs branch May 29, 2026 06:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

documentation Docs, docs, docs.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@HofmeisterAn