-
Notifications
You must be signed in to change notification settings - Fork 154
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: 🔖 release new versions #1218
Conversation
38393c6
to
60544c7
Compare
788b99a
to
1e1991a
Compare
a9e30b1
to
8f1014a
Compare
8f1014a
to
1354148
Compare
8b80718
to
8abae6f
Compare
docs/changelog.md
Outdated
|
||
### Minor Changes | ||
|
||
- Added join support for OAS 3.1 definitions. |
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.
Isn't this a feature?
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.
Yes, it is. So it goes as a minor change according to semver: https://semver.org/#summary
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.
We're following https://keepachangelog.com/en/1.1.0/ format though. You are changing the format.
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.
We're following https://keepachangelog.com/en/1.1.0/ format though.
We are not following it from what I can see. Prior 1.0.0 we were using Features
and Fixes
.
It was changed on 1.0.0 when we moved to to autogenerated changelog. I think we can adjust our script to keep Features
and Fixes
instead of Minor Changes
and Patch Changes
.
@adamaltman @tatomyr what do you think?
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.
I believe the current format is widely used by comunity, so it's better to adhere to it as it is.
I think I can add an admonition to the changelog that we've adopted the Changesets approach since v1.0 for the time being. And later we can discuss what to do with the changelog format.
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.
I believe the current format is widely used by comunity
Other formats are also used widely by community, see examples:
https://github.com/stoplightio/spectral/blob/develop/CHANGELOG.md
https://github.com/swagger-api/swagger-ui/releases
https://github.com/Redocly/redoc/blob/main/CHANGELOG.md
https://github.com/NativeScript/nx/blob/main/CHANGELOG.md
I prefer Features
and Fixes
because not everyone is familiar with sevmer terminology.
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.
Yes, but I mean it's the default format for Changesets and a lot of projects use it, so I don't expect too much troubles with understanding it. Anyways, we already have entries like this, so the changelog needs to be adjusted (and we can do this after the release). I'm going to set up a call to discuss the format we want to use.
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.
This format is nice for libraries but a lot of "products" out there don't use semver language because the audience for products may be a bit different. Do you have any reasons against using Features
and Fixes
(other than there is a little work required on our end)?
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.
Not at all, except it's a default which is always a good idea to stick with.
0e0627d
to
c6f4256
Compare
c6f4256
to
173dd41
Compare
|
Coverage report
Test suite run success625 tests passing in 91 suites. Report generated by 🧪jest coverage report action from 173dd41 |
This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.
Releases
@redocly/cli@1.1.0
Minor Changes
ignoreCase
option fortags-alphabetical
rule.join
support for OAS 3.1 definitions.Patch Changes
--remove-unused-components
option removed used components that were referenced as child objects.no-path-trailing-slash
rule.@redocly/openapi-core@1.1.0
Minor Changes
ignoreCase
option fortags-alphabetical
rule.Patch Changes
--remove-unused-components
option removed used components that were referenced as child objects.no-path-trailing-slash
rule.