OpenAPITools / OpenAPITools/openapi-diff

Add official Github action for openapi-diff

Abierto
#186 4 comentarios 20 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

enhancement
Lenguaje dominante
Java
Estrellas
1.1k
Forks
190
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza revisando los puntos de entrada existentes del repositorio y la configuración de release o automatización; el issue no menciona archivos ni tests. Compara el comportamiento solicitado con las actions no oficiales enlazadas y determina cómo debería exponer una action oficial los resultados de OpenAPI diff y las comprobaciones de breaking changes. Se considera completado cuando una GitHub Action utilizable está documentada y validada para workflows de pull request y generación de informes.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
github-actions, java, openapi
Área
api, ci-cd, devops
Tipo de issue
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.