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.

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

Add migration guide for Uppy 3.x, Companion 4.x, and Robodog #3913

Merged
merged 22 commits into from Aug 22, 2022

Conversation

Murderlon
Copy link
Member

@Murderlon Murderlon commented Jul 27, 2022

No description provided.

Copy link
Member

@aduh95 aduh95 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably call out somewhere that latest versions of most plugins are only supported on Uppy 3.x, and reciprocally migrating to Uppy 3.x requires to upgrade all the Uppy plugins (if only we had all major version numbers lined up am I right)

website/src/docs/migration-guides.md Outdated Show resolved Hide resolved
website/src/docs/migration-guides.md Outdated Show resolved Hide resolved
website/src/docs/migration-guides.md Outdated Show resolved Hide resolved
website/src/docs/migration-guides.md Outdated Show resolved Hide resolved
@aduh95
Copy link
Member

aduh95 commented Jul 29, 2022

We probably also need a section "Migrate from Robodog to Uppy plugins".

Murderlon and others added 4 commits August 3, 2022 11:57
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
* 3.x: (30 commits)
  @uppy/screen-capture: fix TODOs (#3930)
  @uppy/status-bar: rename internal modules (#3929)
  @uppy/transloadit: remove static properties in favor of exports (#3927)
  @uppy/informer: simplify `render` method (#3931)
  @uppy/url: remove private methods from public API (#3934)
  @uppy/dashboard: change `copyToClipboard` signature (#3933)
  @uppy/drop-target: remove `isFileTransfer` from the public API (#3932)
  meta: improve beta release script
  Release: uppy@3.0.0-beta.3 (#3918)
  Release: uppy@2.13.1 (#3916)
  Fix exports in propTypes.js to fix website build
  @uppy/compressor: fix upload causing meta name to reset (#3890)
  @uppy/transloadit: cancel assemblies when all its files have been removed (#3893)
  Add retries for flaky e2e test (#3915)
  Fix `uppy.close()` crashes when remote-sources or image-editor is installed (#3914)
  Add missing type for retry-all event (#3901)
  Companion app type (#3899)
  e2e: upgrade to Cypress 10 (#3896)
  Fix website build
  Create new issue templates (#3879)
  ...
@Murderlon Murderlon marked this pull request as ready for review August 3, 2022 15:32
Murderlon and others added 2 commits August 3, 2022 17:38
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
@Murderlon Murderlon changed the title Add migration guide for Uppy 3.x and Companion 4.x Add migration guide for Uppy 3.x, Companion 4.x, and Robodog Aug 4, 2022
Co-authored-by: Mikael Finstad <finstaden@gmail.com>
@Murderlon Murderlon changed the base branch from 3.x to main August 4, 2022 16:16
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
website/src/docs/migration-guides.md Show resolved Hide resolved
website/src/docs/migration-guides.md Outdated Show resolved Hide resolved
website/src/docs/migration-guides.md Show resolved Hide resolved
@Murderlon Murderlon merged commit 8773dcd into main Aug 22, 2022
@Murderlon Murderlon deleted the migration-guide branch August 22, 2022 18:08
@github-actions github-actions bot mentioned this pull request Aug 22, 2022
github-actions bot added a commit that referenced this pull request Aug 22, 2022
**Migration guides:**
https://uppy.io/docs/migration-guides.html

| Package                   | Version | Package                   | Version |
| ------------------------- | ------- | ------------------------- | ------- |
| @uppy/angular             |   0.4.0 | @uppy/progress-bar        |   3.0.0 |
| @uppy/audio               |   1.0.0 | @uppy/provider-views      |   3.0.0 |
| @uppy/aws-s3              |   3.0.0 | @uppy/react               |   3.0.0 |
| @uppy/aws-s3-multipart    |   3.0.0 | @uppy/react-native        |   0.4.0 |
| @uppy/box                 |   2.0.0 | @uppy/redux-dev-tools     |   3.0.0 |
| @uppy/companion           |   4.0.0 | @uppy/remote-sources      |   1.0.0 |
| @uppy/companion-client    |   3.0.0 | @uppy/screen-capture      |   3.0.0 |
| @uppy/compressor          |   1.0.0 | @uppy/status-bar          |   3.0.0 |
| @uppy/core                |   3.0.0 | @uppy/store-default       |   3.0.0 |
| @uppy/dashboard           |   3.0.0 | @uppy/store-redux         |   3.0.0 |
| @uppy/drag-drop           |   3.0.0 | @uppy/svelte              |   2.0.0 |
| @uppy/drop-target         |   2.0.0 | @uppy/thumbnail-generator |   3.0.0 |
| @uppy/dropbox             |   3.0.0 | @uppy/transloadit         |   3.0.0 |
| @uppy/facebook            |   3.0.0 | @uppy/tus                 |   3.0.0 |
| @uppy/file-input          |   3.0.0 | @uppy/unsplash            |   3.0.0 |
| @uppy/form                |   3.0.0 | @uppy/url                 |   3.0.0 |
| @uppy/golden-retriever    |   3.0.0 | @uppy/utils               |   5.0.0 |
| @uppy/google-drive        |   3.0.0 | @uppy/vue                 |   1.0.0 |
| @uppy/image-editor        |   2.0.0 | @uppy/webcam              |   3.0.0 |
| @uppy/informer            |   3.0.0 | @uppy/xhr-upload          |   3.0.0 |
| @uppy/instagram           |   3.0.0 | @uppy/zoom                |   2.0.0 |
| @uppy/locales             |   3.0.0 | uppy                      |   3.0.0 |
| @uppy/onedrive            |   3.0.0 |                           |         |

- docs: Use RemoteSources in readme example (Artur Paikin / #4030)
- docs: Add migration guide for Uppy 3.x, Companion 4.x, and Robodog (Merlijn Vos / #3913)
- example: upgrade React example to use React 18 (Antoine du Hamel / #4002)
- meta: fix linter failures (Antoine du Hamel / #4029)
- @uppy/vue: move `@uppy/` packages to peer dependencies (Antoine du Hamel / #4024)
- @uppy/robodog: remove package (Antoine du Hamel / #3946)
- example: migrate `digitalocean-spaces` to ESM (Antoine du Hamel / #4015)
- example: replace Robodog example with Transloadit + RemoteSources + Form (Antoine du Hamel / #4027)
- website: replace Robodog example with Uppy plugins (Artur Paikin / #4026)
- @uppy/aws-s3,@uppy/tus,@uppy/xhr-upload: @uppy/tus, @uppy/xhr-upload, @uppy/aws-s3: `metaFields` -> `allowedMetaFields` (Merlijn Vos / #4023)
- example: showcase migration out of Robodog (Antoine du Hamel / #4021)
- example: fix Svelte dev mode (Antoine du Hamel / #4025)
- example: fix docs and env for Vite examples (Antoine du Hamel / #4018)
- @uppy/tus: avoid crashing when Tus client reports an error (Antoine du Hamel / #4019)
- @uppy/react: move `@uppy/` packages to peer dependencies (Antoine du Hamel / #4004)
- @uppy/core: core: uppy.addFile should accept browser File objects (Artur Paikin / #4020)
- example: fix svelte example (Antoine du Hamel / #4017)
- example: migrate `python-xhr` to ESM (Antoine du Hamel / #4010)
- example: migrate `php-xhr` to ESM (Antoine du Hamel / #4009)
- example: migrate `node-xhr` to ESM (Antoine du Hamel / #4008)
- example: migrate `xhr-bundle` to ESM (Antoine du Hamel / #4012)
- example: migrate `multiple-instances` to ESM (Antoine du Hamel / #4007)
- example: replace `transloadit-textarea` with `transloadit-markdown-bin` (Antoine du Hamel / #4013)
- example: add README to Svelte example (Antoine du Hamel / #4011)
- build: Remove size-limit for now (Artur Paikin / #4003)
- @uppy/core,@uppy/dashboard,@uppy/status-bar: Style tweaks: use all: initial + other resets (Artur Paikin / #3983)
- @uppy/aws-s3: aws-s3: fix incorrect comparison for `file-removed` (Merlijn Vos / #3962)
- example: update to new CDN export names (Antoine du Hamel / #4006)
- example: fix dependencies of `bundled` example (Antoine du Hamel / #4005)
- @uppy/tus: fix dependencies (Antoine du Hamel / #3923)
- @uppy/tus: add file argument to `onBeforeRequest` (Merlijn Vos / #3984)
- @uppy/utils: fix drop of multiple files on Chromium browsers (Antoine du Hamel / #3998)
- @uppy/angular: upgrade to Angular 14 (Antoine du Hamel / #3997)
- example: update Angular example to v14 (Antoine du Hamel / #3996)
- @uppy/utils: Fix @uppy/utils microtip.scss export (Merlijn Vos / #3995)
- docs: Companion: make streaming upload recommended & other docs tweaks (Mikael Finstad / #3994)

### 3.0.0-beta.5
### 3.0.0-beta.4
### 3.0.0-beta.3
### 3.0.0-beta.2
### 3.0.0-beta.1
### 3.0.0-beta
Murderlon added a commit that referenced this pull request Aug 23, 2022
* main: (63 commits)
  @uppy/angular: fix peer dependencies (#4035)
  uppy.io homepage: Add Tus
  Fix uppy.io homepage example
  Release: uppy@3.0.0 (#4031)
  Update README.md
  Update README.md
  meta: Use RemoteSources in readme example (#4030)
  Add migration guide for Uppy 3.x, Companion 4.x, and Robodog (#3913)
  example: upgrade React example to use React 18 (#4002)
  readme: Use new ESM syntax (#4028)
  fixup! meta: fix linter failures (#4029)
  @uppy/vue: move `@uppy/` packages to peer dependencies (#4024)
  meta: fix linter failures (#4029)
  @uppy/robodog: remove package (#3946)
  example: migrate `digitalocean-spaces` to ESM (#4015)
  example: replace Robodog example with Transloadit + RemoteSources + Form (#4027)
  website: replace Robodog example with Uppy plugins (#4026)
  @uppy/tus, @uppy/xhr-upload, @uppy/aws-s3: `metaFields` -> `allowedMetaFields` (#4023)
  example: showcase migration out of Robodog (#4021)
  example: fix Svelte dev mode (#4025)
  ...
HeavenFox pushed a commit to docsend/uppy that referenced this pull request Jun 27, 2023
**Migration guides:**
https://uppy.io/docs/migration-guides.html

| Package                   | Version | Package                   | Version |
| ------------------------- | ------- | ------------------------- | ------- |
| @uppy/angular             |   0.4.0 | @uppy/progress-bar        |   3.0.0 |
| @uppy/audio               |   1.0.0 | @uppy/provider-views      |   3.0.0 |
| @uppy/aws-s3              |   3.0.0 | @uppy/react               |   3.0.0 |
| @uppy/aws-s3-multipart    |   3.0.0 | @uppy/react-native        |   0.4.0 |
| @uppy/box                 |   2.0.0 | @uppy/redux-dev-tools     |   3.0.0 |
| @uppy/companion           |   4.0.0 | @uppy/remote-sources      |   1.0.0 |
| @uppy/companion-client    |   3.0.0 | @uppy/screen-capture      |   3.0.0 |
| @uppy/compressor          |   1.0.0 | @uppy/status-bar          |   3.0.0 |
| @uppy/core                |   3.0.0 | @uppy/store-default       |   3.0.0 |
| @uppy/dashboard           |   3.0.0 | @uppy/store-redux         |   3.0.0 |
| @uppy/drag-drop           |   3.0.0 | @uppy/svelte              |   2.0.0 |
| @uppy/drop-target         |   2.0.0 | @uppy/thumbnail-generator |   3.0.0 |
| @uppy/dropbox             |   3.0.0 | @uppy/transloadit         |   3.0.0 |
| @uppy/facebook            |   3.0.0 | @uppy/tus                 |   3.0.0 |
| @uppy/file-input          |   3.0.0 | @uppy/unsplash            |   3.0.0 |
| @uppy/form                |   3.0.0 | @uppy/url                 |   3.0.0 |
| @uppy/golden-retriever    |   3.0.0 | @uppy/utils               |   5.0.0 |
| @uppy/google-drive        |   3.0.0 | @uppy/vue                 |   1.0.0 |
| @uppy/image-editor        |   2.0.0 | @uppy/webcam              |   3.0.0 |
| @uppy/informer            |   3.0.0 | @uppy/xhr-upload          |   3.0.0 |
| @uppy/instagram           |   3.0.0 | @uppy/zoom                |   2.0.0 |
| @uppy/locales             |   3.0.0 | uppy                      |   3.0.0 |
| @uppy/onedrive            |   3.0.0 |                           |         |

- docs: Use RemoteSources in readme example (Artur Paikin / transloadit#4030)
- docs: Add migration guide for Uppy 3.x, Companion 4.x, and Robodog (Merlijn Vos / transloadit#3913)
- example: upgrade React example to use React 18 (Antoine du Hamel / transloadit#4002)
- meta: fix linter failures (Antoine du Hamel / transloadit#4029)
- @uppy/vue: move `@uppy/` packages to peer dependencies (Antoine du Hamel / transloadit#4024)
- @uppy/robodog: remove package (Antoine du Hamel / transloadit#3946)
- example: migrate `digitalocean-spaces` to ESM (Antoine du Hamel / transloadit#4015)
- example: replace Robodog example with Transloadit + RemoteSources + Form (Antoine du Hamel / transloadit#4027)
- website: replace Robodog example with Uppy plugins (Artur Paikin / transloadit#4026)
- @uppy/aws-s3,@uppy/tus,@uppy/xhr-upload: @uppy/tus, @uppy/xhr-upload, @uppy/aws-s3: `metaFields` -> `allowedMetaFields` (Merlijn Vos / transloadit#4023)
- example: showcase migration out of Robodog (Antoine du Hamel / transloadit#4021)
- example: fix Svelte dev mode (Antoine du Hamel / transloadit#4025)
- example: fix docs and env for Vite examples (Antoine du Hamel / transloadit#4018)
- @uppy/tus: avoid crashing when Tus client reports an error (Antoine du Hamel / transloadit#4019)
- @uppy/react: move `@uppy/` packages to peer dependencies (Antoine du Hamel / transloadit#4004)
- @uppy/core: core: uppy.addFile should accept browser File objects (Artur Paikin / transloadit#4020)
- example: fix svelte example (Antoine du Hamel / transloadit#4017)
- example: migrate `python-xhr` to ESM (Antoine du Hamel / transloadit#4010)
- example: migrate `php-xhr` to ESM (Antoine du Hamel / transloadit#4009)
- example: migrate `node-xhr` to ESM (Antoine du Hamel / transloadit#4008)
- example: migrate `xhr-bundle` to ESM (Antoine du Hamel / transloadit#4012)
- example: migrate `multiple-instances` to ESM (Antoine du Hamel / transloadit#4007)
- example: replace `transloadit-textarea` with `transloadit-markdown-bin` (Antoine du Hamel / transloadit#4013)
- example: add README to Svelte example (Antoine du Hamel / transloadit#4011)
- build: Remove size-limit for now (Artur Paikin / transloadit#4003)
- @uppy/core,@uppy/dashboard,@uppy/status-bar: Style tweaks: use all: initial + other resets (Artur Paikin / transloadit#3983)
- @uppy/aws-s3: aws-s3: fix incorrect comparison for `file-removed` (Merlijn Vos / transloadit#3962)
- example: update to new CDN export names (Antoine du Hamel / transloadit#4006)
- example: fix dependencies of `bundled` example (Antoine du Hamel / transloadit#4005)
- @uppy/tus: fix dependencies (Antoine du Hamel / transloadit#3923)
- @uppy/tus: add file argument to `onBeforeRequest` (Merlijn Vos / transloadit#3984)
- @uppy/utils: fix drop of multiple files on Chromium browsers (Antoine du Hamel / transloadit#3998)
- @uppy/angular: upgrade to Angular 14 (Antoine du Hamel / transloadit#3997)
- example: update Angular example to v14 (Antoine du Hamel / transloadit#3996)
- @uppy/utils: Fix @uppy/utils microtip.scss export (Merlijn Vos / transloadit#3995)
- docs: Companion: make streaming upload recommended & other docs tweaks (Mikael Finstad / transloadit#3994)

### 3.0.0-beta.5
### 3.0.0-beta.4
### 3.0.0-beta.3
### 3.0.0-beta.2
### 3.0.0-beta.1
### 3.0.0-beta
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants