Skip to content
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

chore: updaet readme and changelog #183

Merged
merged 2 commits into from
Mar 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!--

Thank you for your contirubtion! 👍
Thank you for your contribution! 👍

-->

Expand All @@ -25,4 +25,4 @@ Thank you for your contirubtion! 👍

<!-- Please keep this section. -->

Please upvode with reacting as :+1: to express your agreement.
Please upvote with reacting as :+1: to express your agreement.
14 changes: 14 additions & 0 deletions .github/workflows/release-drafter-main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Release Drafter

on:
push:
branches:
- main

jobs:
update_release_draft:
runs-on: ubuntu-latest
steps:
- uses: release-drafter/release-drafter@v5
env:
GITHUB_TOKEN: ${{ secrets.PAT }}
5 changes: 1 addition & 4 deletions .github/workflows/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
name: Release Drafter

on:
push:
branches:
- main
pull_request:
types: [opened, reopened, synchronize]

Expand All @@ -13,4 +10,4 @@ jobs:
steps:
- uses: release-drafter/release-drafter@v5
env:
GITHUB_TOKEN: ${{ secrets.PAT }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

## [0.18.0](https://github.com/aspida/openapi2aspida/compare/v0.17.0...v0.18.0) (2022-03-07)


### Bug Fixes

* drop support for current required behavior and just provide the conversion follow specs (https://github.com/aspida/openapi2aspida/pull/179)
* escape description comment (https://github.com/aspida/openapi2aspida/pull/179)
* fix when query param to be required (https://github.com/aspida/openapi2aspida/pull/179#r817536624)

## [0.17.0](https://github.com/aspida/openapi2aspida/compare/v0.16.5...v0.17.0) (2022-01-13)


Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@

## Breaking change :warning:

### 2022/03/07
Since openapi2aspida >= `0.18.0` , decision whether to be required follows the OpenAPI spec correctly. Dropping the support for original implementation, that was defaulting to required.

### 2021/03/15
Since openapi2aspida >= `0.16.0` , requires TypeSciprt 3.8 or higher for Type-Only Imports.

Expand Down