OpenAPITools / OpenAPITools/openapi-diff

Add official Github action for openapi-diff

未关闭
#186 4 条评论 20 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

enhancement
主要语言
Java
星标
1.1k
派生
190
PR 合并指标
30 天内没有已合并 PR

描述

Openapi-diff is well suited to be integrate into Github actions in order to:

  • Highlight breaking in a pull request
  • Document changes in OpenAPI
  • etc.

For example, today we have an internal github repo which on every commit triggers generating Redoc OpenAPI documentation and publishes it to Github pages for the repository. In this documentation we'd like to include a openapi-diff markdown report of the changes.

Or, when ever we do a pull request we want to review the changes made. Openapi-diff will allow us to identify automatically breaking changes.

There are a couple of unofficial limited Github actions based on other openapi diff tool

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先检查仓库现有的入口点以及发布或自动化配置;该 issue 未指定任何文件或测试。将请求的行为与链接的非官方 actions 进行比较,并确定官方 action 应如何提供 OpenAPI diff 结果和 breaking-change 检查。完成的标准是:为 pull-request 和报告生成工作流记录并验证一个可用的 GitHub Action。

由索引模型根据 Issue 内容生成。

评估

技术栈
github-actions, java, openapi
领域
api, ci-cd, devops
Issue 类型
功能
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。