-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
CI: generate openapi contract before asking for contract diff #21
base: main
Are you sure you want to change the base?
Conversation
552efab
to
07007b5
Compare
07007b5
to
0902340
Compare
With this commit: Review can be deleted (operation added) Boon can not be deleted (operation removed, this is a breaking change)
🚨 Breaking API change detected: Added (1)
Removed (1)
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Many thanks for this suggestion @paulRbr.
Could we discuss sync about the strategy here, and the new process allowed by this cutom GitHub action?
- name: Comment pull request with API diff | ||
uses: bump-sh/github-action@v1 | ||
with: | ||
doc: apiplatform-test-demo | ||
token: ${{secrets.BUMP_TOKEN}} | ||
file: docs/openapi.json | ||
file: api/openapi.json |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is it possible to keep contract on same file docs/openapi.json ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or does it mean openapi contract is not persisted anymore (there is no file api/openapi.json
with second commit)
options: -v ${{github.workspace}}/api:/srv/app -v /srv/app/vendor | ||
run: | | ||
composer require symfony/runtime | ||
php bin/console api:openapi:export > openapi.json |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is it possible to keep contract on same file docs/openapi.json ?
Add an additional step to automatically generate to API contract in the CI step.