Shutdown Check

搜索文档

查找页面或章节

查看变更内容,确认已安装的版本,并安全升级。

文档对应的当前版本是 shutdown-check 1.0.1。它在 1.0.0 首个稳定版功能的基础上,增加了 CommonJS 支持和版本号参数。

还没有发布任何版本。

这条时间线根据 re-sohail/shutdown-check 在 GitHub 上的 Releases 生成。第一个版本发布后,这里会自动更新,参见 GitHub 上的 Releases。

1.0.1 版本

这个维护版本新增了:

  • CommonJS 入口
  • 对应 CommonJS 的 TypeScript 类型声明
  • shutdown-check --version
  • 简写参数 -v
  • 包元数据和文档的改进

CommonJS 项目现在可以这样使用:

const { checkShutdown, defineConfig } = require("shutdown-check");

ESM 的用法保持不变:

import { checkShutdown, defineConfig } from "shutdown-check";

1.0.0 版本

首个稳定版包含:

  • 真实启动进程并在结束后清理
  • 轮询就绪检查
  • response-headers 和 probe 两种启动确认
  • 1 到 20 个同时进行的测试请求
  • 发送 SIGTERM,可选择重复发送
  • 检查是否撤回就绪状态、是否拒绝新请求
  • 校验响应状态码和响应体
  • 校验进程是否在截止时间前退出,以及退出码
  • 最终校验端口已关闭
  • 稳定的诊断码
  • 文本、JSON 和 JUnit 输出
  • CLI 和带类型的 Node.js API

查看已安装的版本

npx shutdown-check --version

也可以查看本地依赖:

npm list shutdown-check

在 CI 中使用项目本地安装的版本,确保结果与开发环境一致。

升级

npm install -D shutdown-check@latest

升级之后:

  1. 运行 shutdown-check --version。
  2. 在本地运行现有的关闭测试。
  3. 检查文本时间线和退出码。
  4. 如果 CI 会用到 JUnit 输出,重新生成或检查这份输出。
  5. 提交 lockfile 的变更。

从 1.0.0 升级到 1.0.1 不需要迁移配置。

更新日志从哪里来?

版本信息来自包中的 CHANGELOG.md 和已发布的版本元数据。文档通过构建时的检查,确保其中介绍的 CLI、API 和配置与安装的包保持一致。