OpenAPITools / OpenAPITools/openapi-diff
Add official Github action for openapi-diff
Nessuno ha ancora preso questa issue.
- Lingua principale
- Java
- Stelle
- 1.1k
- Fork
- 190
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia esaminando gli entry point esistenti del repository e la configurazione di release o automazione; l’issue non indica file né test. Confronta il comportamento richiesto con le action non ufficiali collegate e determina come un’action ufficiale dovrebbe esporre i risultati di OpenAPI diff e i controlli delle breaking changes. Il lavoro è completato quando una GitHub Action utilizzabile è documentata e validata per i workflow di pull request e di generazione dei report.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- github-actions, java, openapi
- Ambito
- api, ci-cd, devops
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100