如何自动保持 repo 包依赖项的更新

照片由Andrea De Santis在Unsplash上拍摄

TL;DR

了解如何实现 dependabot 来自动更新您的依赖项，打开一个已更新 dep 的 pr，在此拉取请求中运行测试，并在成功时自动合并。

开发人员的日常任务

开发人员的工作通常让人联想到好莱坞电影里那些聪明人或黑客在打字，屏幕上却只能看到各种绿色代码的场景。又或者，在一个漆黑的房间里，只有显示器的灯光才能看到。

但是，开发人员的工作和大多数工作一样。每天都会遇到问题需要解决，需要理解日常任务，并思考解决问题的最佳方法。而且，就像任何其他工作一样，开发人员的日常任务也会占用我们一天的时间。

你可以把开发者的日常工作比作开餐馆。每天你走进餐厅，必须：打开窗户，打开灯，清理地板，洗碗，拉开椅子，等等，正如我所说：这些都是日常任务。

更新软件包的依赖关系是日常任务之一。而且，随着项目逐渐壮大，手动维护变得越来越困难。

自动化

使用 GitHub 操作任务更容易抽象，并且通过此任务让我们创建：

Dependabot 配置将每天打开一个新的拉取请求来更新特定的依赖关系。
负责从此拉取请求中的应用程序运行测试的 GitHub 操作已打开
如果拉取请求内部的检查结果成功，Github 操作将负责合并此拉取请求。

这些流程协同工作。因此，编写测试以确保 Dependabot 每天正常运行非常重要，并且这些测试还负责识别更新中的问题。

Dependabot 配置

让我们添加一个配置来每天运行一个 dependabot 来查找应用程序内部依赖项的更新。

您的项目根目录下可能会有一个名为的文件夹.github。如果没有，请立即手动创建。
在其中创建一个新文件并将其命名为 dependabot.yml
放置下面的代码

version: 2
updates:
  - package-ecosystem: npm
    directory: '/'
    schedule:
      interval: daily
      time: '01:00'
    open-pull-requests-limit: 10

这个 yml 文件将为 dependabot 设置配置：

它每天打开一个拉取请求
间隔时间为 01:00
最大限制为 100
Dependabot 的每次拉取请求都会给所有者存储库带来新的通知

工作流文件夹

在创建 GitHub 操作之前，如果工作流文件夹尚不存在，则需要创建它。

在里面.github创建一个新文件夹并命名为工作流

测试 GitHub 操作

重要提示：此流程负责运行您的应用程序测试。因此，预计已配置好 Jest 环境。如果您还没有配置，现在就可以开始编写测试了。

让我们创建 GitHub 操作，负责运行每个打开的拉取请求内的存储库中的所有测试。

在工作流文件夹中创建一个新文件并命名为test.yml
放置下面的代码

name: tests

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2
      - name: Setup Node.js
        uses: actions/setup-node@v2
        with:
          node-version: "14"
      - run: yarn
      - run: yarn jest

该 yml 文件将设置一个新的操作来负责：

运行每个拉取请求内的所有测试，这些测试将合并到主分支上。
它将运行 yarn 命令来安装所有依赖项。
然后将运行 yarn jest 来运行所有测试。

Dependabot 自动合并 GitHub 操作

让我们创建一个 GitHub 操作，负责自动合并 Dependabot 提交的拉取请求。当所有检查都通过后，此操作将自动合并。

在工作流中创建一个新文件并命名为auto-merge.yml
放置下面的代码

name: auto-merge

on:
  pull_request_target:
    branches:
      - main

jobs:
  auto-merge:
    runs-on: ubuntu-latest
    if: github.actor == 'dependabot[bot]'
    steps:
      - uses: ahmadnassri/action-dependabot-auto-merge@v2.4
        with:
          github-token: ${{ secrets.AUTOMERGE_TOKEN }}
          command: 'squash and merge'
          target: minor