Skip to content

[docs-scanner] Jenkins example has incorrect comment #25083

@docker-agent

Description

@docker-agent

File: content/manuals/scout/integrations/environment/cli.md

Issue

The Jenkins example has a comment that doesn't match the command:

// Analyze and fail on critical or high vulnerabilities
sh 'docker-scout environment --org "<MY_DOCKER_ORG>" "<ENVIRONMENT>" $IMAGE_TAG

The comment says "Analyze and fail on critical or high vulnerabilities" but the command is docker-scout environment, which records an image to an environment. It doesn't analyze images or fail on vulnerabilities.

Why this matters

A reader would be confused about what this command actually does. The comment suggests it's performing vulnerability analysis and potentially failing the build, but the command only records the environment assignment.

Suggested fix

Update the comment to match the actual command:

// Record image to environment
sh 'docker-scout environment --org "<MY_DOCKER_ORG>" "<ENVIRONMENT>" $IMAGE_TAG

Or simply:

sh 'docker-scout environment --org "<MY_DOCKER_ORG>" "<ENVIRONMENT>" $IMAGE_TAG

Found by nightly documentation quality scanner

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/scoutRelates to Docker Scout

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions