node-asana icon indicating copy to clipboard operation
node-asana copied to clipboard

Missing changelog

Open miso-belica opened this issue 2 years ago • 6 comments

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?

miso-belica avatar Aug 07 '23 07:08 miso-belica

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

jv-asana avatar Aug 08 '23 01:08 jv-asana

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

miso-belica avatar Aug 08 '23 07:08 miso-belica

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.

jv-asana avatar Aug 09 '23 00:08 jv-asana

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

supersime avatar Aug 09 '23 04:08 supersime

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

jv-asana avatar Aug 09 '23 05:08 jv-asana

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 https://github.com/Asana/node-asana/issues/286#issuecomment-1670695683, 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

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:
  <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="https://github.com/Asana/node-asana/issues/286#issuecomment-1670695683" 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>&lt;Asana/node-asana/issues/286/1670695683</span><span>@</span><span>github</span><span>.</span><span>com&gt;</span></span></p>
  <script type="application/ld+json">[

{ @.": "http://schema.org", @.": "EmailMessage", "potentialAction": { @.": "ViewAction", "target": "https://github.com/Asana/node-asana/issues/286#issuecomment-1670695683", "url": "https://github.com/Asana/node-asana/issues/286#issuecomment-1670695683", "name": "View Issue" }, "description": "View this Issue on GitHub", "publisher": { @.": "Organization", "name": "GitHub", "url": "https://github.com" } } ]


--------------bfdr83uLpfYRD4QE05ododuY--

supersime avatar Aug 09 '23 05:08 supersime