Agoric / documentation

User documentation
https://agoric.com/documentation/
Apache License 2.0
15 stars 39 forks source link

Upgrade deprecated packages #609

Open tgrecojs opened 2 years ago

tgrecojs commented 2 years ago

Came across issue #513 a few moments ago which attempts to address migrating this repo to make use of vuepress v2. This led me to review vuepress' migration guide, after which I arrived at the conclusion that upgrading the vuepress package didn't seem as though it would break the current repo.

I managed to upgrade the repo to make use of vuepress@1.9.7, which is the latest prod release. (I've since realized that vuepress v2 is still in beta (as shown in the project's changelog). After upgrading, I had no issue running any of the commands defined within the project - everything still ran the same.

This process led me to discover that we're not utilizing the latest releases of various packages embedded within the agoric-sdk. Below is a screengrab showing the result of running yarn upgrade-interactive from within the repo and shows what i'm referring to.

https://user-images.githubusercontent.com/6646552/150058369-2412e86b-8615-450e-b005-40b8d7d22848.mp4

Pasting the logs below for the sake of clarity.

documentation % yarn upgrade-interactive
yarn upgrade-interactive v1.22.5
info Color legend :
 "<red>"    : Major Update backward-incompatible updates
 "<yellow>" : Minor Update backward-compatible features
 "<green>"  : Patch Update backward-compatible bug fixes
? Choose which packages to update.
 ◯ esm                        agoric-labs/esm#Agoric-built  3.2.25   ❯  exotic  agoric-labs/esm#Agoric-built

 devDependencies
   name                       range                         from        to      url
 ◯ @agoric/assert             *                             0.2.12   ❯  0.3.15  https://github.com/Agoric/agoric-sdk#readme
 ◯ @agoric/bundle-source      *                             1.3.7    ❯  2.0.1   https://github.com/Agoric/agoric-sdk#readme
 ◯ @agoric/ertp               *                             0.11.2   ❯  0.13.1  https://github.com/Agoric/agoric-sdk#readme
 ◯ @agoric/eventual-send      *                             0.13.14  ❯  0.14.0  https://github.com/Agoric/agoric-sdk#readme
 ◯ @agoric/install-ses        *                             0.5.13   ❯  0.5.29  https://github.com/Agoric/agoric-sdk#readme
 ◯ @agoric/notifier           *                             0.3.14   ❯  0.3.33  https://github.com/Agoric/agoric-sdk#readme
 ◯ @agoric/promise-kit        *                             0.2.13   ❯  0.2.29  https://github.com/Agoric/agoric-sdk#readme
 ◯ @typescript-eslint/parser  ^4.26.0                       4.26.0   ❯  4.33.0  https://github.com/typescript-eslint/typescript-eslint#readme
❯◯ eslint                     ^7.27.0                       7.28.0   ❯  7.32.0  https://eslint.org
 ◯ eslint-plugin-import       ^2.23.4                       2.23.4   ❯  2.25.4  https://github.com/import-js/eslint-plugin-import
 ◯ eslint-plugin-jsdoc        ^35.1.2                       35.1.2   ❯  35.5.1  https://github.com/gajus/eslint-plugin-jsdoc#readme
 ◯ eslint-plugin-prettier     ^3.4.0                        3.4.0    ❯  3.4.1   https://github.com/prettier/eslint-plugin-prettier#readme
 ◯ vuepress                   ^1.8.2                        1.8.2    ❯  1.9.7   https://github.com/vuejs/vuepress#readme

 dependencies
   name                       range                         from        to      url
 ◯ @agoric/marshal            *                             0.4.25   ❯  0.5.0   https://github.com/Agoric/agoric-sdk#readme
 ◯ @agoric/zoe                *                             0.15.7   ❯  0.21.1  https://github.com/Agoric/agoric-sdk#readme
 ◯ typescript                 ^4.0.3                        4.3.2    ❯  4.5.4   https://www.typescriptlang.org/

Wrapping this up - I've come away from this with the following questions:

  1. Is there a priority, or a hesitancy towards upgrading the docs to using the latest version of vuepress?
  2. Is there a priority or a hesitancy towards upgrading the docs to using the latest version of the various agoric-sdk packages? If upgrading these packages is the desired path, I'm wondering if this would require tasks such as removing outdated API text from the docs, upgrading code snippets to use newer APIs, etc. 🤔
dckc commented 2 years ago

@arirubinstein maybe you want to look at this as well as the dependencies in agoric-sdk?

Tyrosine22 commented 1 year ago

@arirubenstein: Did you ever have a chance to look into this?