Skip to content

Commit

Permalink
add info
Browse files Browse the repository at this point in the history
  • Loading branch information
@lantoli
lantoli committed Oct 16, 2024
1 parent 69cc711 commit 2935ce2
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions tools/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,9 @@ This enables us to verify new templates changes.
Templates are sourced from openapi generator:

https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator/src/main/resources/go

## Go API Diff

We use [go-apidiff](https://github.com/joelanford/go-apidiff) to detect if there are breaking changes and a new major version release is needed.
In [Generate SDK Github action](../.github/workdlows/autoupdate-prod.yaml), `API_DIFF_OLD_COMMIT` and `API_DIFF_NEW_COMMIT` are used to do the comparison.

0 comments on commit 2935ce2

Please sign in to comment.