plotly / plotly/angular-plotly.js

Feature request: please add migration guide

Open
#285 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
242
Forks
81
Avg merge
8h 48m
Merged PRs (30d)
18

Description

Hello,

I'm maintaining an app with angular 12 and angular-plotly.js 2.0.0.

When migrating to angular 13, I got this error:

$ ng update @angular/core@13 @angular/cli@13
Fetching dependency metadata from registry...
                  Package "angular-plotly.js" has an incompatible peer dependency to "@angular/core" (requires "^9.0.0" (extended), would install "13.4.0").
✖ Migration failed: Incompatible peer dependencies found.
Peer dependency warnings when installing dependencies means that those dependencies might not work correctly together.
You can use the '--force' option to ignore incompatible peer dependencies and instead address these warnings later.

Looking through this repo by tags and checking at the package.json, I'm assuming that the right version for angular 13 is angular-plotly.js 5.0.0

It would be great to have a simple version mapping between angular-plotly.js and Angular (e.g. angular.dev/reference/versions), and especially a short list of breaking changes if any for each major version . That would really help developers trying to upgrade.

Thanks in advance 🙏

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing package.json and the repository tags to verify which angular-plotly.js versions correspond to Angular releases. Document the version mapping and check the major-version history for breaking changes; done means a short migration guide covers each mapping and its relevant upgrade notes.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, typescript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.