-
Notifications
You must be signed in to change notification settings - Fork 1
Configure Dependabot + Documentation #53
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
Open
aaronashby
wants to merge
4
commits into
main
Choose a base branch
from
45-set-up-dependabot
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| version: 2 | ||
| updates: | ||
| # Enable version updates for npm | ||
| - package-ecosystem: "npm" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "weekly" | ||
| assignees: | ||
| - "aaronashby" | ||
| - "thaninbew" | ||
| open-pull-requests-limit: 3 | ||
|
|
||
| # Enable version updates for Docker | ||
| - package-ecosystem: "docker" | ||
| directory: "/apps/backend" | ||
| schedule: | ||
| interval: "weekly" | ||
| assignees: | ||
| - "aaronashby" | ||
| - "thaninbew" | ||
| open-pull-requests-limit: 3 | ||
|
|
||
| # Enable version updates for GitHub Actions | ||
| - package-ecosystem: "github-actions" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "weekly" | ||
| assignees: | ||
| - "aaronashby" | ||
| - "thaninbew" | ||
| open-pull-requests-limit: 3 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| # Dependabot Workflow | ||
|
|
||
| ## Overview | ||
|
|
||
| Dependabot is a GitHub-native tool that automatically opens pull requests to keep dependencies up to date. Its configuration settings are located in `.github/dependabot.yml`, and runs weekly. | ||
|
|
||
| ## What Dependabot Updates | ||
|
|
||
| - **Node.js dependencies**: Dependencies declared in `package.json` and the lockfile `yarn.lock` | ||
| - **Docker dependencies**: Updates base image tags referenced by Dockerfiles (e.g. the one in `apps/backend`) | ||
| - **GitHub Actions**: Updates action versions used in workflows in `.github/workflows` | ||
|
|
||
| ## Schedule and Ownership | ||
|
|
||
| Dependabot creates PRs on a **weekly** basis, and automatically assigns the PRs to `aaronashby` and `thaninbew` | ||
|
|
||
| ## How to Review Dependabot PRs | ||
|
|
||
| - Skim the PR title, release notes, and commits | ||
| - Check the diff | ||
| - Dependency updates often change `package.json` + `yarn.lock` (or only `yarn.lock`). | ||
| - Docker updates typically change a `FROM …` line. | ||
| - Actions updates usually change `uses: …@vX` pins in workflows. | ||
|
|
||
| ## Merging Guidelines (suggested) | ||
|
|
||
| - **Patch/minor updates**: usually safe to merge once CI passes. | ||
| - **Major updates**: prefer a quick manual smoke test and a scan for breaking changes. | ||
| - **Lockfile-only updates**: merge if CI passes (these happen due to dependency resolution changes). | ||
|
|
||
| ## Common Tweaks (edit `.github/dependabot.yml`) | ||
|
|
||
| - **Add a separate Docker entry for root compose files** | ||
| - Dependabot currently only scans Docker in `/apps/backend`. If you want it to update `docker-compose.dev.yml` at the repo root, add another docker update with `directory: "/"`. | ||
| - **Limit PR volume** | ||
| - Add `open-pull-requests-limit: <number>` to an update block. | ||
| - **Ignore versions** | ||
| - Use `ignore:` to skip major versions or specific packages temporarily. | ||
| - **Group updates** | ||
| - Use `groups:` to bundle related packages (e.g., React, NestJS, Nx) into fewer PRs. | ||
|
|
||
| ## Troubleshooting | ||
| - **CI fails after a bump** | ||
| - Check the package’s changelog/release notes and revert/ignore if needed. | ||
| - If it’s a tooling bump (Nx/Vite/ESLint/TypeScript), failures often come from peer dependency changes or config deprecations. | ||
| - **Dependabot isn’t opening PRs** | ||
| - Confirm `.github/dependabot.yml` is on the default branch and syntactically valid. | ||
| - Check the repo’s Dependabot alerts/PRs in GitHub for run history and errors. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
noice docs!