-
Notifications
You must be signed in to change notification settings - Fork 73
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
Comments
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: |
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 :) |
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. |
A cheat-sheet for code migration from 1.x to 2.x would be VERY welcomed please! |
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. |
Hi John,
I'm just doing a bunch of upgrades... this one is really great as it
gives you an example of old code and new code:
https://mongoosejs.com/docs/migrating_to_7.html
Simon
…On 9/8/23 14:54, John V. wrote:
Hi @supersime <https://github.com/supersime>, is there anything in
particular you are looking for in a migration guide?
If you go to our developer documentation
<https://developers.asana.com/reference/rest-api-reference> 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
<https://user-images.githubusercontent.com/99784540/259303312-3e360a8a-08d7-418f-878f-e207ebab347e.png>
—
Reply to this email directly, view it on GitHub
<#286 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AG7PYY266G523NUFTCVMZ2DXUMNJZANCNFSM6AAAAAA3GRSTPI>.
You are receiving this because you were mentioned.Message ID:
***@***.***>
--------------bfdr83uLpfYRD4QE05ododuY
Content-Type: text/html; charset=UTF-8
Content-Transfer-Encoding: 8bit
<html><head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<font face="Arial">Hi John,<br>
<br>
I'm just doing a bunch of upgrades... this one is really great as
it gives you an example of old code and new code:
<a class="moz-txt-link-freetext" href="https://mongoosejs.com/docs/migrating_to_7.html">https://mongoosejs.com/docs/migrating_to_7.html</a><br>
<br>
Simon<br>
</font><br>
<div class="moz-cite-prefix">On 9/8/23 14:54, John V. wrote:<br>
</div>
<blockquote type="cite" ***@***.***">
<p dir="auto">Hi <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/supersime/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://github.com/supersime" ***@***.***</a>,
is there anything in particular you are looking for in a
migration guide?</p>
<p dir="auto">If you go to our <a href="https://developers.asana.com/reference/rest-api-reference" rel="nofollow" moz-do-not-send="true">developer documentation</a>
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.</p>
<a target="_blank" rel="noopener noreferrer" href="https://user-images.githubusercontent.com/99784540/259303312-3e360a8a-08d7-418f-878f-e207ebab347e.png" moz-do-not-send="true"><img alt="old_vs_new_node_asana" src="https://user-images.githubusercontent.com/99784540/259303312-3e360a8a-08d7-418f-878f-e207ebab347e.png" style="max-width: 100%;" moz-do-not-send="true" width="1488"></a>
<p style="font-size:small;-webkit-text-size-adjust:none;color:#666;">—<br>
Reply to this email directly, <a href="#286 (comment)" moz-do-not-send="true">view it on GitHub</a>, or <a href="https://github.com/notifications/unsubscribe-auth/AG7PYY266G523NUFTCVMZ2DXUMNJZANCNFSM6AAAAAA3GRSTPI" moz-do-not-send="true">unsubscribe</a>.<br>
You are receiving this because you were mentioned.<img src="https://github.com/notifications/beacon/AG7PYYYFKAPF4BCUUXIAMK3XUMNJZA5CNFSM6AAAAAA3GRSTPKWGG33NNVSW45C7OR4XAZNMJFZXG5LFINXW23LFNZ2KUY3PNVWWK3TUL5UWJTTDSTFQG.gif" alt="" moz-do-not-send="true" width="1" height="1"><span style="color: transparent; font-size: 0; display: none;
visibility: hidden; overflow: hidden; opacity: 0; width: 0;
height: 0; max-width: 0; max-height: 0; mso-hide: all">Message
ID: <span><Asana/node-asana/issues/286/1670695683</span><span>@</span><span>github</span><span>.</span><span>com></span></span></p>
<script type="application/ld+json">[
{
***@***.***": "http://schema.org",
***@***.***": "EmailMessage",
"potentialAction": {
***@***.***": "ViewAction",
"target": "#286 (comment)",
"url": "#286 (comment)",
"name": "View Issue"
},
"description": "View this Issue on GitHub",
"publisher": {
***@***.***": "Organization",
"name": "GitHub",
"url": "https://github.com"
}
}
]</script>
</blockquote>
<br>
</body>
</html>
--------------bfdr83uLpfYRD4QE05ododuY--
|
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?
The text was updated successfully, but these errors were encountered: