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

Migration guide from v1 to v2? #787

Closed
rhansen opened this issue Nov 22, 2021 · 4 comments
Closed

Migration guide from v1 to v2? #787

rhansen opened this issue Nov 22, 2021 · 4 comments
Labels
good first issue Good for newcomers and first-timer contributors Priority: Low This issue can probably be picked up by anyone looking to contribute to the project. Status: Accepted It's clear what the subject of the issue is about, and what the resolution should be. Type: Documentation An Issue or Pull Request for improving or updating documentation.

Comments

@rhansen
Copy link

rhansen commented Nov 22, 2021

Support plan

  • which support plan is this issue covered by? (e.g. Community, Sponsor, or
    Enterprise): Community
  • is this issue currently blocking your project? (yes/no): no
  • is this issue affecting a production system? (yes/no): no

Context

  • node version: v16.13.0
  • module (formidable) version: v1.2.6
  • environment (e.g. node, browser, native, OS): node
  • used with (i.e. popular names of modules):
  • any other relevant information:

What problem are you trying to solve?

What changes are needed to migrate from v1.2.6 to v2.0.1? CHANGELOG.md is not very readable, and VERSION_NOTES.md doesn't mention any compatibility-breaking changes other than Node.js 10+. Can we simply upgrade to v2.0.1 and expect everything to work without any changes?

Do you have a new or modified API suggestion to solve the problem?
@GrosSacASac
Copy link
Contributor

PR welcome :)

It depends on what features you used. The interface of certain objects has changed.

@tunnckoCore
Copy link
Member

Can we simply upgrade to v2.0.1 and expect everything to work without any changes?

Almost, yes. I think it's just the resulted "File" object propeties. See #773 for the different names of props.

I can add a diff codeblock in the v2 part of the version notes, based on that 773.

@tunnckoCore tunnckoCore added good first issue Good for newcomers and first-timer contributors Priority: Low This issue can probably be picked up by anyone looking to contribute to the project. Status: Accepted It's clear what the subject of the issue is about, and what the resolution should be. Type: Documentation An Issue or Pull Request for improving or updating documentation. and removed docs labels Apr 2, 2022
@karlhorky karlhorky mentioned this issue Jun 18, 2023
Closed
@karlhorky
Copy link

Looks like now that v3 is latest on npm, a guide from v2 to v3 will also be needed...

@GrosSacASac
Copy link
Contributor

The changelog is the migration guide. If almost no compatibility changes are mentioned , well it is because there are very few.

If something specific is missing then open an issue about that specific thing.

I am closing this issue but if someone wants to volunteer and write a hand holding guide then by all means PR are opens

@GrosSacASac GrosSacASac mentioned this issue Jul 7, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers and first-timer contributors Priority: Low This issue can probably be picked up by anyone looking to contribute to the project. Status: Accepted It's clear what the subject of the issue is about, and what the resolution should be. Type: Documentation An Issue or Pull Request for improving or updating documentation.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@rhansen @karlhorky @tunnckoCore @GrosSacASac