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.

Sign up for GitHub

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

Jump to bottom

Dependency package typedoc has a new version available #19241

Closed
azure-sdk opened this issue Dec 10, 2021 · 3 comments
Closed

Dependency package typedoc has a new version available #19241

azure-sdk opened this issue Dec 10, 2021 · 3 comments
Labels
Client This issue points to a problem in the data-plane of the library. dependency-upgrade-required EngSys This issue is impacting the engineering system. help wanted This issue is tracking work for which community contributions would be welcomed and appreciated

Comments

@azure-sdk
Copy link
Collaborator

azure-sdk commented Dec 10, 2021 •
edited
Loading

We have identified a dependency on version 0.15.2 of typedoc. A new version (0.22.15) is available for upgrade.

Following are the steps to upgrade package dependency.

  1. Understand the breaking changes between the version being used and the version you want to upgrade to.

  2. Identify all packages that take a dependency on this package.

  3. Go to the root folder for each such package (/sdk/service-name/package-name) and update package.json to have the new version.

  4. Run rush update to ensure the new version is pulled in.

  5. Make relevant changes to absorb the breaking changes.

  6. Repeat steps 3 to 5 for each of the packages that have a dependency on this package.
@ghost ghost added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Dec 10, 2021
@jeremymeng jeremymeng mentioned this issue Dec 13, 2021
Closed
@jeremymeng jeremymeng added Client This issue points to a problem in the data-plane of the library. EngSys This issue is impacting the engineering system. good first issue This issue tracks work that may be a good starting point for a first-time contributor help wanted This issue is tracking work for which community contributions would be welcomed and appreciated labels Dec 13, 2021
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Dec 13, 2021
@jeremymeng
Copy link
Member

We are discussing removing of typedoc dependency and the docs npm script from package.json files intead of upgrading in #17076

@jeremymeng jeremymeng mentioned this issue Dec 13, 2021
Closed
@ramya-rao-a
Copy link
Contributor

Please use this issue for the following work

  • Update the generate-doc tool to use the latest version of typedoc. When updating here, the index.js file in the linked folder will also need to be updated as certain options are no longer supported in the latest version of typedoc.

@ramya-rao-a ramya-rao-a added this to the Backlog milestone Dec 15, 2021
@azure-sdk azure-sdk removed help wanted This issue is tracking work for which community contributions would be welcomed and appreciated good first issue This issue tracks work that may be a good starting point for a first-time contributor EngSys This issue is impacting the engineering system. Client This issue points to a problem in the data-plane of the library. labels Feb 7, 2022
@jeremymeng jeremymeng added the Client This issue points to a problem in the data-plane of the library. label Mar 9, 2022
@jeremymeng jeremymeng added EngSys This issue is impacting the engineering system. help wanted This issue is tracking work for which community contributions would be welcomed and appreciated labels May 5, 2022
@mpodwysocki mpodwysocki mentioned this issue May 10, 2022
Closed
2 tasks
@mpodwysocki
Copy link
Member

Should be closed as we're not currently investing in the docs pipeline as per discussion in #21810

@xirzec xirzec removed this from the Backlog milestone May 17, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Apr 11, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Client This issue points to a problem in the data-plane of the library. dependency-upgrade-required EngSys This issue is impacting the engineering system. help wanted This issue is tracking work for which community contributions would be welcomed and appreciated
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@xirzec @jeremymeng @mpodwysocki @ramya-rao-a @azure-sdk