DEV Community

EME GUG
EME GUG

Posted on

Keeping Dependencies Fresh Without Drowning in PRs: A Practical Renovate Setup for Small Teams

Hầu như team nào cũng có một repo mà không ai dám chạy npm update. Lần cuối dependency được nâng cấp là cách đây 2 năm, package-lock.json toàn version cũ, và mỗi lần có CVE mới là cả team phải ngồi cả tuần để "nâng cấp một lần cho xong". Mình từng gặp cảnh đó vài lần. Sau đó mình chuyển hết sang dùng Renovate để tự động hoá việc này. Nhưng nếu cài Renovate với config mặc định thì chỉ sau một tuần bạn sẽ nhận 40 PR, cả team bấm mute notification, và rốt cuộc lại không ai merge cái nào. Bài này chia sẻ cách mình cấu hình Renovate cho team nhỏ (3-8 người) để dependency luôn được cập nhật mà không ai bị ngợp.

Tại sao Renovate mà không phải Dependabot?

Dependabot có sẵn trên GitHub, bật lên là chạy, nên rất tiện. Nhưng khi số repo tăng lên thì mình thấy nó thiếu mấy thứ quan trọng:

  • Grouping linh hoạt: Renovate cho gộp mọi bản @types/* vào một PR, hoặc gộp tất cả bản patch vào một PR mỗi tuần. Dependabot đã có groups nhưng vẫn kém linh hoạt hơn nhiều.
  • minimumReleaseAge: chỉ đề xuất version đã được publish ít nhất N ngày. Đây là lớp phòng thủ rẻ nhất trước package bị compromise, vì phần lớn package độc hại bị gỡ khỏi registry trong vòng 24-72 giờ.
  • Dependency Dashboard: một issue tổng hợp tất cả update đang chờ. Bạn tick vào checkbox là Renovate tạo PR.
  • Đa platform: GitHub, GitLab, Bitbucket, Gitea, kể cả GitLab self-hosted mà nhiều công ty ở Việt Nam đang dùng.
  • Hỗ trợ hơn 90 package manager: npm, pip, Poetry, uv, Go modules, Docker, Helm, Terraform, GitHub Actions...

Flow hoạt động của Renovate như sau:

flowchart LR
    A[Renovate chạy theo schedule] --> B[Scan manifest files]
    B --> C{Có version mới?}
    C -- Không --> Z[Kết thúc]
    C -- Có --> D{Đủ minimumReleaseAge?}
    D -- Chưa --> E[Pending trên Dashboard]
    D -- Đủ --> F{Loại update}
    F -- patch/minor devDeps --> G[Automerge nếu CI xanh]
    F -- major --> H[Tạo PR chờ review]

Config "chống spam" mình dùng cho mọi repo

Đây là renovate.json mình copy vào hầu hết các project Node.js/TypeScript. Đã test với Renovate 39.x trở lên:

{
  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
  "extends": ["config:recommended", ":dependencyDashboard"],
  "timezone": "Asia/Ho_Chi_Minh",
  "schedule": ["before 9am on monday"],
  "prConcurrentLimit": 5,
  "prHourlyLimit": 2,
  "minimumReleaseAge": "3 days",
  "rangeStrategy": "pin",
  "lockFileMaintenance": {
    "enabled": true,
    "schedule": ["before 9am on the first day of the month"]
  },
  "vulnerabilityAlerts": {
    "enabled": true,
    "schedule": ["at any time"],
    "minimumReleaseAge": null
  },
  "packageRules": [
    {
      "description": "Gộp tất cả patch + minor của devDependencies, tự merge",
      "matchDepTypes": ["devDependencies"],
      "matchUpdateTypes": ["patch", "minor"],
      "groupName": "dev dependencies (non-major)",
      "automerge": true,
      "automergeType": "branch"
    },
    {
      "description": "Gộp @types vào một PR",
      "matchPackageNames": ["/^@types\//"],
      "groupName": "type definitions",
      "automerge": true
    },
    {
      "description": "Major update luôn cần người review",
      "matchUpdateTypes": ["major"],
      "automerge": false,
      "labels": ["dependencies", "breaking"],
      "minimumReleaseAge": "14 days"
    },
    {
      "description": "Pin GitHub Actions bằng digest",
      "matchManagers": ["github-actions"],
      "pinDigests": true,
      "groupName": "github actions"
    }
  ]
}
Enter fullscreen mode Exit fullscreen mode

Vài điểm đáng chú ý:

  • automergeType: "branch": Renovate push thẳng vào branch rồi merge khi CI pass, không tạo PR. Không có PR thì không có notification. Đây là thay đổi giảm noise nhiều nhất.
  • vulnerabilityAlerts bỏ qua schedule và minimumReleaseAge: bản vá bảo mật phải vào ngay, không chờ đến thứ Hai.
  • rangeStrategy: "pin": với application thì pin version chính xác (4.18.2 thay vì ^4.18.2). Với library publish lên npm thì nên đổi thành "widen" hoặc "bump".
  • matchPackageNames với regex /.../: cú pháp mới. matchPackagePatterns đã deprecated, nên đừng copy config cũ trên StackOverflow.

Automerge chỉ an toàn khi CI của bạn thật sự test được gì đó. Repo có coverage 5% mà bật automerge thì chẳng khác gì cho bot quyền deploy code chưa ai review lên production.

Test config local trước khi push

Sai một dấu phẩy trong renovate.json là Renovate sẽ tạo issue báo lỗi config trên repo. Mình luôn validate và dry-run ở local trước:

# Validate cú pháp và các option đã deprecated
npx --yes --package renovate -- renovate-config-validator renovate.json

# Dry-run trên repo local: chỉ lookup, không tạo branch/PR
LOG_LEVEL=debug npx --yes renovate \
  --platform=local \
  --dry-run=lookup \
  2>&1 | tee renovate-dryrun.log

# Xem nhanh những update Renovate sẽ đề xuất
grep -E '"newVersion"|"depName"' renovate-dryrun.log | paste - - | head -30
Enter fullscreen mode Exit fullscreen mode

--platform=local rất hữu ích vì không cần token và không đụng tới remote. Mình hay chạy lệnh này khi onboard một repo cũ để ước lượng có bao nhiêu update đang chờ trước khi bật Renovate cho cả team.

Self-host bằng GitHub Actions (cho repo private, GitLab, hoặc khi cần kiểm soát)

Mend Renovate App trên GitHub thì cài là xong. Nhưng nhiều công ty không muốn cấp quyền cho app bên ngoài, hoặc cần Renovate truy cập private registry. Khi đó mình chạy Renovate bằng workflow riêng:

sequenceDiagram
    participant Cron as GitHub Actions (cron)
    participant R as Renovate container
    participant Reg as npm / PyPI / Docker Hub
    participant Repo as Target repos
    Cron->>R: Trigger thứ Hai 01:00 UTC
    R->>Repo: Clone + đọc renovate.json
    R->>Reg: Query version mới
    Reg-->>R: Metadata + release date
    R->>Repo: Push branch / tạo PR / automerge
# .github/workflows/renovate.yml
name: Renovate
on:
  schedule:
    - cron: "0 1 * * 1"   # 8h sáng thứ Hai giờ VN
  workflow_dispatch:

jobs:
  renovate:
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@v4
      - uses: renovatebot/github-action@v41  # nên pin bằng SHA
        with:
          configurationFile: .github/renovate-global.json
          token: ${{ secrets.RENOVATE_TOKEN }}
        env:
          LOG_LEVEL: info
          RENOVATE_REPOSITORIES: '["my-org/api", "my-org/web", "my-org/infra"]'
          RENOVATE_NPMRC: ${{ secrets.NPMRC_PRIVATE }}
Enter fullscreen mode Exit fullscreen mode

RENOVATE_TOKEN nên là fine-grained PAT hoặc token của GitHub App, chỉ cấp quyền contents: write, pull_requests: write, issues: write cho đúng các repo cần thiết. Đừng dùng PAT classic có scope repo toàn org.

Cuối cùng, mình có một script nhỏ chạy mỗi sáng thứ Ba để nhắc team về các PR Renovate bị bỏ quên quá 7 ngày:

#!/usr/bin/env bash
# stale-renovate.sh: liệt kê PR Renovate mở quá 7 ngày
set -euo pipefail
CUTOFF=$(date -u -d '7 days ago' +%Y-%m-%dT%H:%M:%SZ 2>/dev/null \
  || date -u -v-7d +%Y-%m-%dT%H:%M:%SZ)   # fallback cho macOS

for repo in my-org/api my-org/web my-org/infra; do
  gh pr list --repo "$repo" --label dependencies --state open \
    --json number,title,createdAt,url \
    --jq ".[] | select(.createdAt < \"$CUTOFF\") | \"[$repo] #\(.number) \(.title)\n  \(.url)\""
done
Enter fullscreen mode Exit fullscreen mode

Những bài học xương máu

  • Đừng bật Renovate cho repo cũ với full config ngay ngày đầu. Bắt đầu bằng "enabled": false cho mọi thứ trừ vulnerabilityAlerts, rồi mỗi tuần mở thêm một nhóm. Nếu không, bạn sẽ nhận 60 PR trong ngày đầu tiên.
  • Lock file maintenance hay gây vỡ ngầm. Nó cập nhật transitive dependency mà không đổi package.json. Nếu CI không đủ test, hãy để nó tạo PR thay vì automerge.
  • Monorepo nên dùng preset group:monorepos (đã có trong config:recommended) để các package như @nestjs/* hay @babel/* được nâng version cùng lúc.
  • Docker image dùng tag latest thì Renovate không giúp được gì. Pin node:22.11-alpine kèm digest thì Renovate mới theo dõi được.

Kết luận

Nâng cấp dependency giống như đánh răng: làm đều mỗi ngày thì nhẹ nhàng, để 2 năm mới làm thì sẽ đau. Những việc bạn có thể làm ngay tuần này:

  1. Chạy dry-run local bằng npx renovate --platform=local --dry-run=lookup để biết repo đang nợ bao nhiêu update.
  2. Copy config ở trên, nhớ chỉnh timezone và schedule theo nhịp làm việc của team.
  3. Bật minimumReleaseAge ít nhất 3 ngày. Đây là cách phòng thủ supply chain rẻ nhất bạn có.
  4. Chỉ automerge khi CI có test thật, và bắt đầu với devDependencies trước.
  5. Mỗi tuần dành 15 phút xem Dependency Dashboard và xử lý major update. Đừng để nó tồn đọng.

Làm đúng thì sau khoảng một tháng, team bạn sẽ quên mất là Renovate đang chạy, vì dependency lúc nào cũng mới và không ai còn phải lo chuyện nâng cấp nữa.

Top comments (0)