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: 🔖 release new versions #1218

Merged
merged 1 commit into from
Sep 14, 2023
Merged

chore: 🔖 release new versions #1218

merged 1 commit into from
Sep 14, 2023

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Aug 8, 2023

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

  • Added ignoreCase option for tags-alphabetical rule.
  • Added join support for OAS 3.1 definitions.
  • Added support for Redoc v2.1.2, and aligned the dependencies for both projects.

Patch Changes

  • Fixed an issue where the --remove-unused-components option removed used components that were referenced as child objects.
  • Updated Redocly config validation.
  • Fixed the location pointer when reporting on the no-path-trailing-slash rule.
  • Updated minimum required version of Node.js to v14 and removed deprecated packages.
  • Updated @redocly/openapi-core to v1.1.0.

@redocly/openapi-core@1.1.0

Minor Changes

  • Added ignoreCase option for tags-alphabetical rule.

Patch Changes

  • Fixed an issue where the --remove-unused-components option removed used components that were referenced as child objects.
  • Updated Redocly config validation.
  • Fixed the location pointer when reporting on the no-path-trailing-slash rule.

@github-actions github-actions bot requested a review from a team as a code owner August 8, 2023 05:26
@github-actions github-actions bot force-pushed the changeset-release/main branch 3 times, most recently from 38393c6 to 60544c7 Compare August 8, 2023 13:14
@github-actions github-actions bot force-pushed the changeset-release/main branch 7 times, most recently from 788b99a to 1e1991a Compare August 18, 2023 13:11
docs/changelog.md Outdated Show resolved Hide resolved
docs/changelog.md Outdated Show resolved Hide resolved
@github-actions github-actions bot force-pushed the changeset-release/main branch 2 times, most recently from a9e30b1 to 8f1014a Compare August 22, 2023 14:59
@github-actions github-actions bot force-pushed the changeset-release/main branch from 8f1014a to 1354148 Compare September 8, 2023 12:30
@github-actions github-actions bot force-pushed the changeset-release/main branch 2 times, most recently from 8b80718 to 8abae6f Compare September 12, 2023 06:37
@tatomyr tatomyr mentioned this pull request Sep 12, 2023
5 tasks
docs/changelog.md Outdated Show resolved Hide resolved

### Minor Changes

- Added join support for OAS 3.1 definitions.
Copy link
Member

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?

Copy link
Contributor

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

Copy link
Member

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.

Copy link
Member

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.

image

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?

Copy link
Contributor

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.

Copy link
Member

@RomanHotsiy RomanHotsiy Sep 12, 2023

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.

Copy link
Contributor

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.

Copy link
Member

@RomanHotsiy RomanHotsiy Sep 13, 2023

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)?

Copy link
Contributor

@tatomyr tatomyr Sep 13, 2023

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.

@github-actions github-actions bot force-pushed the changeset-release/main branch 2 times, most recently from 0e0627d to c6f4256 Compare September 13, 2023 12:15
@github-actions github-actions bot force-pushed the changeset-release/main branch from c6f4256 to 173dd41 Compare September 14, 2023 08:39
@tatomyr tatomyr closed this Sep 14, 2023
@tatomyr tatomyr reopened this Sep 14, 2023
@github-actions
Copy link
Contributor Author

Command Mean [s] Min [s] Max [s] Relative
redocly lint packages/core/src/benchmark/benches/rebilly.yaml 1.277 ± 0.015 1.253 1.306 1.00
redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml 1.302 ± 0.024 1.268 1.338 1.02 ± 0.02

@github-actions
Copy link
Contributor Author

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 75.44% 3793/5028
🟡 Branches 66.3% 2103/3172
🟡 Functions 68.6% 638/930
🟡 Lines 75.59% 3543/4687

Test suite run success

625 tests passing in 91 suites.

Report generated by 🧪jest coverage report action from 173dd41

@tatomyr tatomyr requested a review from lornajane September 14, 2023 09:25
@tatomyr tatomyr merged commit b8bf007 into main Sep 14, 2023
@tatomyr tatomyr deleted the changeset-release/main branch September 14, 2023 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants