Skip to content

Commit dcf97a8

Browse files
committed
docs: add missing plugin configuration to migration guidee
1 parent df68b6e commit dcf97a8

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

site/source/docs/migrating_from_3.x.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,13 @@ However, we did introduce some small breaking changes. We removed:
8383

8484
## Updating to v5
8585

86+
- [Better Smart Contract configuration](#Better-Smart-Contract-configuration)
87+
- [Simplified Blockchain configuration](#Simplified-Blockchain-configuration)
88+
- [Communication configuration](#Communication-configuration)
89+
- [Embark Plugins](#Embark-Plugins)
90+
- [Tests](#Tests)
91+
- [Library and Version updates](#Library-and-Version-updates)
92+
8693
Embark's 5th version is full of improvements, especially in the configurations, all to make your life easier.
8794

8895
In this guide, we'll go through the different breaking changes introduced in Embark 5, that will let you upgrade from Embark 4.0.
@@ -195,6 +202,41 @@ module.exports = {
195202
}
196203
```
197204

205+
### Embark Plugins
206+
207+
A lot of functionality of Embark has been extracted into plugins and those need to be installed explicitly when upgrading from v4. This includes things like `embark-geth` to spin up a blockchain, `embark-profiler` and `embark-graph`. Notice that these are entirely optional though.
208+
209+
To make this work, add the needed plugins as dependencies to your project's `package.json`:
210+
211+
212+
```json
213+
{
214+
...
215+
"devDependencies": {
216+
...
217+
"embark-geth": "^5.2.3",
218+
"embark-ipfs": "^5.2.3",
219+
"embark-swarm": "^5.2.3",
220+
"embark-whisper-geth": "^5.2.3",
221+
}
222+
}
223+
```
224+
225+
Once these are installed, list them inside of your project's `embark.json` so Embark knows which ones to load when booting up:
226+
227+
```json
228+
{
229+
...
230+
"plugins": {
231+
"embark-ipfs": {},
232+
"embark-whisper-geth": {},
233+
"embark-geth": {},
234+
...
235+
},
236+
...
237+
}
238+
```
239+
198240
### Tests
199241

200242
There were few breaking changes related to `embark test`, mostly new features.

0 commit comments

Comments
 (0)