OpenAPITools / OpenAPITools/openapi-diff

Add official Github action for openapi-diff

Offen
#186 4 Kommentare 20 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

enhancement
Vorherrschende Sprache
Java
Sterne
1.1k
Forks
190
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der Prüfung der bestehenden Einstiegspunkte des Repositorys sowie der Release- oder Automatisierungskonfiguration; im Issue werden keine Dateien oder Tests genannt. Vergleiche das gewünschte Verhalten mit den verlinkten inoffiziellen Actions und ermittle, wie eine offizielle Action OpenAPI-diff-Ergebnisse und Prüfungen auf Breaking Changes bereitstellen sollte. Als abgeschlossen gilt die Arbeit, wenn eine nutzbare GitHub Action für Pull-Request- und Berichtserstellungs-Workflows dokumentiert und validiert ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
github-actions, java, openapi
Bereich
api, ci-cd, devops
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.