Skip to content

Commit

Permalink
Update docs about resolutions
Browse files Browse the repository at this point in the history
  • Loading branch information
avoinea committed Nov 17, 2021
1 parent b4115c4 commit e0af879
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,27 @@

1. Happy hacking!

## Resolutions

Volto EEA KitKat provides a set of generic Volto Add-ons and a `Known Good Set` of these add-ons versions to be used within your Volto projects without having to worry about which add-on version works best with another add-on.

While in other systems when you pin a package version to a specific number you will get that package version, in Javascript world [is not that simple](https://medium.com/swlh/welcome-to-dependency-hell-754a896f0440).

For this, Volto EEA Kitkat is using [selective dependency resolutions](https://classic.yarnpkg.com/lang/en/docs/selective-version-resolutions/). While this work as expected in most of the cases, you may still have some surprises.

### Troubleshooting

1. Make sure your Volto project `yarn.lock` is not polluted. You can always reset your Volto project `yarn.lock` with:

$ npm install -g @plone/generator-volto
$ cd my-volto-project
$ yo @plone/volto --skip-install --no-interactive /tmp/new-volto-project
$ cp /tmp/new-volto-project/yarn.lock .
$ yarn

2. Add-on `resolutions` don't work with `workspaces` (development mode), thus you'll need to define `resolutions` within Volto project. To tackle this issue, this Docker image automatically extracts `resolutions` from add-on and add them also to the Volto project before running tests.


### Try `volto-eea-kitkat` with Docker

1. Get the latest Docker images
Expand Down

0 comments on commit e0af879

Please sign in to comment.