wesleytodd/express-openapi

Release 1.0.0

Closed this issue · 5 comments

Just wanted to put together a quick 1.0.0 plan. We have two breaking changes lined up:

I was thinking maybe we should quickly tackle a few of the open issues as well before we release?

  • #20: This one might require some work adding a test that covers it. (@AustinGil not sure if you are still using the package and/or want to help)
  • #25: This should be relatively easy. If we wanted we could even generate the .d.ts files and test them (ex pkgjs/nv#15).
  • #22: Also TS related, not sure I remember enough about this one to be sure what we need to do or if it is a reasonable ask.
  • #19: This one maybe @AustinGil could comment on as well? Do we want this?

Maybe we don't need to land all this, most of these are non breaking and could go out after 1.0.0, but just wanted to see what folks thought.

cc @Megapixel99 @enov @thomasheartman

I can look at addressing most of those issues once #50 and #52 are merged. #25 and #22 may take a bit longer though as I am not well versed in TypeScript, and I have only used it a couple of times in the past.

What if we start a 1.0.0 release branch and re-target those two onto it? Then we can land them now but I can still publish the existing main line (I just have not yet had time to test it all before publish). If you wanted you could do that and then merge and we can just move this issue into the body of the PR description.

I just created the branch release/v1.0.0 and retargeted both PRs.

Once you merge let me know and I can re-open this as a PR instead of an issue.

Both #50 and #52 are merged. I will look at the other issues now.