v0.2.0-beta
Pre-release
Pre-release
0.2.0-beta (July 14, 2024)
Below is a list of all new features, APIs, deprecations, and breaking changes.
New Features
- Diffs are not only provided as a github actions output, but also can be sent to slack channels.
Slack
class was added to handle all slack-related tasks. Credentials for Slack and channel Ids must be provided. Details can be seen in README.md - Internationalization (i18n) support for Korean for Slack messages. Locale can be provided as a Github Actions input.
- Supports both
pull_request
event andpush
event.pull_request
will compare the base branch andpush
will compare the target branch, and the state of one commit behind the target branch. - Path for openapi json file can be provided as a Github Actions input. Default is
openapi.json
at the root directory of the project. - Output of the diff can now be accessed via
diff_result
.result
will be deprecated in future releases.
Improvements
- Diffing task of two openapi documents is now done by an external library, openapi-diff-node a javascript-based diffing library for nodeJS. All existing diffing codes are removed.
Other Changes
- Set default font to
Pretendard
for development (debugging) web page. Fallback fonts will be used ifPretendard
is not installed locally. (Font file not included) - Irrelevant test cases are removed. Test cases will be added in future releases.