Skip to content

Commit 6db47ac

Browse files
documentation: include migration guide
The commit introduces a `migration guide` to the framework to help downstream extensions and applications migrate to newer versions of the framework. Signed-off-by: vince-fugnitto <vincent.fugnitto@ericsson.com> Co-authored-by: Paul Maréchal <paul.marechal@ericsson.com>
1 parent dece352 commit 6db47ac

File tree

2 files changed

+48
-0
lines changed

2 files changed

+48
-0
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ Read below how to engage with Theia community:
8686
- Useful Links:
8787
- [Developing](doc/Developing.md)
8888
- [Testing](doc/Testing.md)
89+
- [Migration Guide](doc/Migration.md)
8990
- [API Integration Testing](doc/api-testing.md)
9091
- [Coding Guidelines](https://github.com/eclipse-theia/theia/wiki/Coding-Guidelines)
9192
- [Code Organization](https://github.com/eclipse-theia/theia/wiki/Code-Organization)

doc/Migration.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Migration Guide
2+
3+
## Description
4+
5+
The following guide highlights potential migration steps necessary during `theia` upgrades discovered when adopting the framework.
6+
7+
## Guide
8+
9+
### v1.16.0
10+
11+
[Release](https://github.com/eclipse-theia/theia/releases/tag/v1.16.0)
12+
13+
- TBD.
14+
15+
### v1.15.0
16+
17+
[Release](https://github.com/eclipse-theia/theia/releases/tag/v1.15.0)
18+
19+
- `keytar`:
20+
- [`keytar`](https://github.com/atom/node-keytar) was added as a dependency for the secrets API. and may require `libsecret` in your particular distribution to be functional:
21+
- Debian/Ubuntu: `sudo apt-get install libsecret-1-dev`
22+
- Red Hat-based: `sudo yum install libsecret-devel`
23+
- Arch Linux: `sudo pacman -S libsecret`
24+
- It is possible that a `yarn resolution` is necessary for `keytar` to work on older distributions (the fix was added in `1.16.0` by downgrading the dependency version):
25+
```json
26+
"resolutions": {
27+
"**/keytar": "7.6.0",
28+
}
29+
```
30+
- `keytar` uses [`prebuild-install`](https://github.com/prebuild/prebuild-install) to download prebuilt binaries. If you are experiencing issues where some shared libraries are missing from the system it was originally built upon, you can tell `prebuild-install` to build the native extension locally by setting the environment variable before performing `yarn`:
31+
```sh
32+
# either:
33+
export npm_config_build_from_source=true
34+
yarn
35+
# or:
36+
npm_config_build_from_source=true yarn
37+
```
38+
39+
- `webpack`:
40+
- The version of webpack was upgraded from 4 to 5 and may require additional shims to work properly given an application's particular setup.
41+
- The `webpack` dependency may need to be updated if there are errors when performing a `production` build of the application due to a bogus `webpack-sources` dependency. The valid `webpack` version includes `^5.36.2 <5.47.0`. If necessary, you can use a `yarn resolution` to fix the issue:
42+
```json
43+
"resolutions": {
44+
"**/webpack": "5.46.0",
45+
}
46+
```
47+

0 commit comments

Comments
 (0)