Skip to content

Promote the Dockerfile, Docker Compose, and Helm Detectors to Experimental Status#1803

Open
jpinz wants to merge 2 commits intomainfrom
jupinzer/promote-container-detectors
Open

Promote the Dockerfile, Docker Compose, and Helm Detectors to Experimental Status#1803
jpinz wants to merge 2 commits intomainfrom
jupinzer/promote-container-detectors

Conversation

@jpinz
Copy link
Copy Markdown
Member

@jpinz jpinz commented May 1, 2026

This pull request updates the status of the Docker Compose, Dockerfile, and Helm component detectors from "DefaultOff" to "Experimental" across both documentation and code. As a result, these detectors now run automatically during scans, but their output is not included in the final scan results. The changes also update the documentation to reflect the new "Experimental" status and clarify how these detectors behave.

Example Run with Detectors Enabled
Components were successfully registered

…ental status

Co-authored-by: Copilot <copilot@github.com>
@jpinz jpinz self-assigned this May 1, 2026
Copilot AI review requested due to automatic review settings May 1, 2026 19:06
@jpinz jpinz requested a review from a team as a code owner May 1, 2026 19:06
@jpinz jpinz requested a review from grvillic May 1, 2026 19:06
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR promotes the Dockerfile, Docker Compose, and Helm detectors from DefaultOff to Experimental so they run by default during scans (with results excluded from the final scan output unless explicitly enabled), and updates detector documentation to reflect the new status.

Changes:

  • Update Helm, Dockerfile, and Docker Compose detector implementations to implement IExperimentalDetector instead of IDefaultOffComponentDetector.
  • Update detector documentation pages to describe the new Experimental behavior.
  • Update the detectors README status tables to mark these detectors as Experimental.
Show a summary per file
File Description
src/Microsoft.ComponentDetection.Detectors/helm/HelmComponentDetector.cs Switch Helm detector to IExperimentalDetector.
src/Microsoft.ComponentDetection.Detectors/dockerfile/DockerfileComponentDetector.cs Switch Dockerfile detector to IExperimentalDetector.
src/Microsoft.ComponentDetection.Detectors/dockercompose/DockerComposeComponentDetector.cs Switch Docker Compose detector to IExperimentalDetector.
docs/detectors/helm.md Update Helm detector status/behavior text to Experimental.
docs/detectors/dockerfile.md Update Dockerfile detector status/behavior text to Experimental.
docs/detectors/dockercompose.md Update Docker Compose detector status/behavior text to Experimental.
docs/detectors/README.md Mark the three detectors as Experimental in the status tables.

Copilot's findings

Comments suppressed due to low confidence (3)

docs/detectors/dockerfile.md:29

  • Known limitations mentions experimental output suppression but doesn’t mention the opt-in path to include results. Please add guidance on using --DetectorArgs DockerReference=Enable (or EnableIfDefaultOff) to include output when needed.
- **Experimental Status**: This detector runs automatically but its output is not included in scan results

docs/detectors/dockercompose.md:45

  • Known limitations should mention how to opt-in to include detector output (e.g., --DetectorArgs DockerCompose=Enable / EnableIfDefaultOff), otherwise users have no documented way to get results from an experimental detector.
- **Experimental Status**: This detector runs automatically but its output is not included in scan results

docs/detectors/helm.md:48

  • Similar to the overview section, the Known limitations entry says experimental output is not included, but doesn’t explain how to opt-in to include results. Please add a note that passing --DetectorArgs Helm=Enable (or EnableIfDefaultOff) will treat it as a normal detector and include its output.
- **Experimental Status**: This detector runs automatically but its output is not included in scan results
  • Files reviewed: 7/7 changed files
  • Comments generated: 3

Comment thread docs/detectors/dockerfile.md Outdated
Comment thread docs/detectors/dockercompose.md Outdated
Comment thread docs/detectors/helm.md Outdated
…ile, dockercompose, and helm docs

Agent-Logs-Url: https://github.com/microsoft/component-detection/sessions/c1b52ac3-7a11-4689-b324-b61c26014208

Co-authored-by: jpinz <8357054+jpinz@users.noreply.github.com>
Copilot finished work on behalf of jpinz May 1, 2026 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants