语义 -- 释放 -- openapi

一个语义放出插件来更新OpenAPI/Swagger规格文件中的版本.

安装

此模块通过 npm 分发, 应该安装为您的工程之一 devDependencies数字 :

npm install --save-dev @aensley/semantic-release-openapi

使用量

插件配置

此插件有一个配置选项必须提供 .

• apiSpecFiles: OpenAPI / Swagger 规格文件路径的阵列. 球状图案 (例如:. '*.yaml') 得到支持.

  所有匹配的文件必须有一个 .json, (中文(简体) ), .yaml,或 .yml 扩展名.

提交更改

重要性: 语义发布不会对您的 OpenAPI spec 文件进行更改, 除非您在其中添加相同的文件 assets 联 合 国 @semantic-release/ git (英语) 插头! 参见下例.

示例

{
  "release": {
    "plugins": [
      [
        "@aensley/semantic-release-openapi",
        {
          "apiSpecFiles": ["openapi.yaml", "src/swagger-*.json"]
        }
      ],
      [
        "@semantic-release/git",
        {
          "assets": ["package.json", "openapi.yaml", "src/swagger-*.json"]
        }
      ]
    ]
  }
}