mirror of
https://github.com/Sea-Haven-Industries/engineering-handbook.git
synced 2026-09-30 05:43:15 +00:00
Merge pull request #1 from Sea-Haven-Industries/feature/dependabot-standards
Add Dependabot version update configuration standards
This commit is contained in:
commit
258948747a
1 changed files with 86 additions and 0 deletions
|
|
@ -6,6 +6,92 @@
|
|||
- Every repo gets a one-line description
|
||||
- Default to `private` visibility for org repos
|
||||
- Dependabot alerts and security updates enabled on all active repos
|
||||
- Org-level defaults auto-enable alerts and security updates on new repos
|
||||
- Every repo with dependencies gets a `.github/dependabot.yml` for weekly version updates
|
||||
|
||||
## Dependabot Configuration
|
||||
|
||||
Every active repo with package dependencies must have a `.github/dependabot.yml` that covers all relevant ecosystems. All entries must assign PRs to `amoussa1229`.
|
||||
|
||||
### Ecosystem Selection
|
||||
|
||||
Choose ecosystems based on what dependency files exist in the repo:
|
||||
|
||||
| File | Ecosystem |
|
||||
|------|-----------|
|
||||
| `package.json` | `npm` |
|
||||
| `requirements.txt` | `pip` |
|
||||
| `.csproj` | `nuget` |
|
||||
| `.github/workflows/*.yml` | `github-actions` |
|
||||
|
||||
### Standard Templates
|
||||
|
||||
**Single ecosystem (npm or pip):**
|
||||
|
||||
```yaml
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: "npm" # or "pip", "nuget", "github-actions"
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
assignees:
|
||||
- "amoussa1229"
|
||||
```
|
||||
|
||||
**SAM project with per-function `requirements.txt`:**
|
||||
|
||||
Add a separate entry for each directory containing a `requirements.txt`:
|
||||
|
||||
```yaml
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: "pip"
|
||||
directory: "/src/processor"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
assignees:
|
||||
- "amoussa1229"
|
||||
- package-ecosystem: "pip"
|
||||
directory: "/src/receiver"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
assignees:
|
||||
- "amoussa1229"
|
||||
```
|
||||
|
||||
**Mixed ecosystems (e.g., CDK in JS with Python Lambdas, or repos with GitHub Actions):**
|
||||
|
||||
Add one entry per ecosystem/directory:
|
||||
|
||||
```yaml
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: "npm"
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
assignees:
|
||||
- "amoussa1229"
|
||||
- package-ecosystem: "pip"
|
||||
directory: "/src"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
assignees:
|
||||
- "amoussa1229"
|
||||
- package-ecosystem: "github-actions"
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
assignees:
|
||||
- "amoussa1229"
|
||||
```
|
||||
|
||||
### Merging Dependabot PRs
|
||||
|
||||
- **Patch and minor bumps:** Safe to merge without review in most cases
|
||||
- **Major version bumps:** Review changelog for breaking changes before merging
|
||||
- When merging multiple Dependabot PRs, merge one at a time — subsequent PRs will auto-rebase
|
||||
|
||||
## Branch Protection
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue