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

'@azure/functions' npm package versioning #428

Closed
ejizba opened this issue Oct 5, 2021 · 1 comment
Closed

'@azure/functions' npm package versioning #428

ejizba opened this issue Oct 5, 2021 · 1 comment

Comments

@ejizba
Copy link
Contributor

ejizba commented Oct 5, 2021

As of right now, the only version of the @azure/functions npm package that has been published is v1.x. However, each new version of the Node.js worker can introduce breaking changes that would affect the TypeScript types. My proposal is that the TypeScript types should be directly tied to the worker version and we should release/maintain each major version that is still supported by the runtime.

@azure/functions version Worker Version Runtime Version
1.x 1.x 2.x
2.x 2.x 3.x
3.x 3.x 4.x

Some notes:

  • With v4 of the runtime, we considered 'aligning' the worker and runtime versions, but long term we want to be able to release the worker separately from the runtime, so the versions would likely diverge eventually anyways. Plus skipping from 2 to 4 could just add confusion.
  • Most users are on v3 of the host by now, but are still using v1 of the typescript types because that's all that we've released. We should refrain from updating v1 types in such a way that may break those users.
@ejizba ejizba added this to the Functions Sprint 112 milestone Oct 19, 2021
@ejizba ejizba modified the milestones: Functions Sprint 112, Functions Sprint 113 Nov 1, 2021
@ejizba ejizba modified the milestones: Functions Sprint 113, November 2021 Nov 15, 2021
@ejizba
Copy link
Contributor Author

ejizba commented Nov 24, 2021

Both v2 and v3 of the npm package have been released. Since we are now caught up with the worker versions, I will go ahead and close this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant