sonatype/AGP - Agentic Patches

AI-powered dependency upgrades for npm projects using pre-built Docker image

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
modeRun mode: 'full' (all updates), 'security' (only vulnerable packages), or 'heal' (rebuild conflicting PRs)nofull
repo_idSonatype Guide repository id (required when mode=heal)no""
vulnerabilitiesJSON array of vulnerabilities to fix (for security mode, typically provided by Guide via workflow_dispatch)no""
working-directoryDirectory containing package.jsonno.
node-versionNode.js version to use (20 or 22)no22
create-prCreate GitHub PRs for upgradesnofalse
draft-prCreate PRs as draftsnofalse
enable-agentEnable AI agent for fixing validation failuresnotrue
max-fix-attemptsMaximum AI fix attempts per groupno3
dry-runPreview changes without applying themnofalse
groupApply only a specific group by IDno""
validation-commandsCommands to validate upgrades (newline-separated)no""
npmrc-content.npmrc file content for private registry authenticationno""
maven-settings-xmlMaven settings.xml content for private repository authenticationno""
verboseEnable verbose output (may expose sensitive data in logs)nofalse
github-tokenOverride for the token used to push commits and open PRs. When unset, the action mints one from the Sonatype Guide OIDC broker so PRs open as sonatype-guide[bot].no""
git-user-nameGit user name for commits. Leave blank to match the authenticating identity (sonatype-guide[bot] when the broker is used).no""
git-user-emailGit user email for commits. Leave blank to match the authenticating identity — e.g. <user-id>+sonatype-guide[bot]@users.noreply.github.com, which is required for GitHub to show the Verified bot badge on commits.no""
docker-imageFully-qualified Docker image path including registry and tag. Defaults to the public Docker Hub image sonatype/agp:latest (no authentication required). To use a private registry, override this and supply docker-username/docker-password.nosonatype/agp:latest
docker-usernameDocker registry username. When provided with docker-password, the action logs into the registry extracted from docker-image before pulling. Leave unset for the public default image.no""
docker-passwordDocker registry password. When provided with docker-username, the action logs into the registry extracted from docker-image before pulling. Leave unset for the public default image.no""
skip-docker-pullSkip pulling the Docker image (for local testing with pre-built images)nofalse
mount-docker-socketMount the host Docker socket into the AGP container, enabling Docker commands and container-based tools (e.g., Testcontainers, Docker Compose) during setup and validationnofalse
namedescription
run-idAGP run tracking ID
groups-upgradedNumber of groups successfully upgraded
groups-failedNumber of groups that failed
pr-urlsJSON array of created PR URLs