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

Missing changelog #286

Open
miso-belica opened this issue Aug 7, 2023 · 6 comments
Open

Missing changelog #286

miso-belica opened this issue Aug 7, 2023 · 6 comments

Comments

@miso-belica
Copy link

I noticed the version of the package jumped from v1.0.2 to v2.0.1 but the re is no changelog for the change. I found some page with API changes but not this package. Can you point me to some document with the changes? And add the link to README or somewhere please?

@jv-asana
Copy link
Contributor

jv-asana commented Aug 8, 2023

Hi @miso-belica, we currently do not document any changes between versions. I can understand why this is important for developers. This is something we would add in the future. As for now, the difference between v1.X.X vs v2.X.X is that v2.X.X is a completely new node client library so the way you make API calls is different compared to v1.X.X. We did to help us keep our client libraries up to date more frequently with our API. If you would like to compare the two versions you can look at the old sample code in our docs:

node_old_docs

@miso-belica
Copy link
Author

Thank you for the answer. I noticed the change is huge. I was also surprised there are no Typescript types available for the new version to help with the transition. Let's keep this task as a bitter reminder the changelog is really needed for the project like this :)

@jv-asana
Copy link
Contributor

jv-asana commented Aug 9, 2023

Hi @miso-belica, thanks for sharing more feedback. We could technically generate a typescript library as well but we require more testing. To give a bit of context, we are using swagger-codegen to generate our new node/javascript client library. We looked at the swagger typescript generator and don't think it is mature enough to support our API. Perhaps down the line we can update to typescript.

@supersime
Copy link

A cheat-sheet for code migration from 1.x to 2.x would be VERY welcomed please!

@jv-asana
Copy link
Contributor

jv-asana commented Aug 9, 2023

Hi @supersime, is there anything in particular you are looking for in a migration guide?

If you go to our developer documentation you should be able to switch between the sample code of the old (v1.X.X) vs the default (v2.X.X). I understand that this might not be the best replacement for a migration guide and might not be enough for developers, so any kind of feedback is welcomed. I'll discuss this with my team and we'll see how we can help developers out with this transition.

old_vs_new_node_asana

@supersime
Copy link

supersime commented Aug 9, 2023 via email

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

No branches or pull requests

3 participants