-
Notifications
You must be signed in to change notification settings - Fork 119
docs: add Dependabot support reference documentation #14669
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
pelikhan
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot remove bloat. See unbloat.md
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Removed bloat from dependabot.md following unbloat-docs.md guidelines. Reduced from 302 lines to 80 lines (73% reduction) while preserving all essential information. Changes in commit bd8a8c5. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Adds reference documentation for gh aw compile --dependabot so users understand how dependency manifests are generated from workflow commands and how to properly resolve Dependabot PRs without introducing manifest drift.
Changes:
- Adds a new “Dependabot Support” reference page documenting generated manifests, recommended PR-fix workflow, and troubleshooting.
- Expands the
compilecommand documentation to describe--dependabotand link to the new reference page.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/src/content/docs/setup/cli.md | Adds --dependabot integration blurb and cross-reference to the new reference page. |
| docs/src/content/docs/reference/dependabot.md | New reference page describing how Dependabot manifests/config are generated and how to handle Dependabot PRs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| **Options:** `--validate`, `--strict`, `--fix`, `--zizmor`, `--dependabot`, `--json`, `--watch`, `--purge` | ||
|
|
||
| **Dependabot Integration (`--dependabot`):** Automatically generates dependency manifests (`package.json`, `requirements.txt`, `go.mod`) and `.github/dependabot.yml` configuration by analyzing runtime tools (`npx`, `pip install`, `go install`) used across all workflows. This enables Dependabot to detect and update outdated dependencies. See [Dependabot Support reference](/gh-aw/reference/dependabot/) for details on handling Dependabot PRs. |
Copilot
AI
Feb 9, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This description implies --dependabot always generates manifests and only scans go install. In reality, manifest generation is skipped when no dependencies are detected, and Go dependencies are extracted from both go install and go get. Consider updating this sentence to reflect the conditional behavior and include go get (and optionally mention package-lock.json since it is also generated for npm).
| **Dependabot Integration (`--dependabot`):** Automatically generates dependency manifests (`package.json`, `requirements.txt`, `go.mod`) and `.github/dependabot.yml` configuration by analyzing runtime tools (`npx`, `pip install`, `go install`) used across all workflows. This enables Dependabot to detect and update outdated dependencies. See [Dependabot Support reference](/gh-aw/reference/dependabot/) for details on handling Dependabot PRs. | |
| **Dependabot Integration (`--dependabot`):** When dependencies are detected, automatically generates dependency manifests (`package.json` + `package-lock.json`, `requirements.txt`, `go.mod`) and `.github/dependabot.yml` configuration by analyzing runtime tools (`npx`, `pip install`, `go install`, `go get`) used across all workflows. This enables Dependabot to detect and update outdated dependencies. See [Dependabot Support reference](/gh-aw/reference/dependabot/) for details on handling Dependabot PRs. |
| order: 750 | ||
| --- | ||
|
|
||
| The `gh aw compile --dependabot` command scans workflows for runtime tools (`npx`, `pip install`, `go install`), generates dependency manifests (`package.json`, `requirements.txt`, `go.mod`), and configures Dependabot to monitor for updates |
Copilot
AI
Feb 9, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The runtime tool list is incomplete. The implementation extracts Go dependencies from both go install and go get (see RequiredSubcommands: ["install", "get"]), so the doc should mention go get as well.
| The `gh aw compile --dependabot` command scans workflows for runtime tools (`npx`, `pip install`, `go install`), generates dependency manifests (`package.json`, `requirements.txt`, `go.mod`), and configures Dependabot to monitor for updates | |
| The `gh aw compile --dependabot` command scans workflows for runtime tools (`npx`, `pip install`, `go install`, `go get`), generates dependency manifests (`package.json`, `requirements.txt`, `go.mod`), and configures Dependabot to monitor for updates |
| order: 750 | ||
| --- | ||
|
|
||
| The `gh aw compile --dependabot` command scans workflows for runtime tools (`npx`, `pip install`, `go install`), generates dependency manifests (`package.json`, `requirements.txt`, `go.mod`), and configures Dependabot to monitor for updates |
Copilot
AI
Feb 9, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing period at the end of this sentence.
| The `gh aw compile --dependabot` command scans workflows for runtime tools (`npx`, `pip install`, `go install`), generates dependency manifests (`package.json`, `requirements.txt`, `go.mod`), and configures Dependabot to monitor for updates | |
| The `gh aw compile --dependabot` command scans workflows for runtime tools (`npx`, `pip install`, `go install`), generates dependency manifests (`package.json`, `requirements.txt`, `go.mod`), and configures Dependabot to monitor for updates. |
The
--dependabotflag generates dependency manifests from workflow commands (npx,pip install,go install), enabling Dependabot to track outdated tools. Users need guidance on the proper fix workflow: edit source.mdfiles and recompile, not merge manifest changes directly.Changes
New reference page (
docs/src/content/docs/reference/dependabot.md)package.json,package-lock.json,requirements.txt,go.mod,dependabot.ymlCLI documentation enhancement (
docs/src/content/docs/setup/cli.md)compile --dependabotdescription with cross-referenceCritical Workflow
When Dependabot opens a PR updating manifests:
This prevents manifest drift and maintains the markdown workflows as the single source of truth.
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.