Skip to content

Commit

Permalink
Document how to migrate projects to Cookieplone
Browse files Browse the repository at this point in the history
  • Loading branch information
stevepiercy committed Jan 28, 2025
1 parent 005b8b5 commit 4ea4f05
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion docs/source/upgrade-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,18 @@ This upgrade guide lists all breaking changes in Volto and explains the steps th
Volto uses Semantic Versioning.
For more information see {doc}`../contributing/version-policy`.

```{note}
````{note}
[Cookieplone](https://github.com/plone/cookieplone) is the official project generator for Plone.
We keep Cookieplone up to date and in sync with the current Volto release.
To make it easier for you to maintain your projects, you should keep all your code inside your project add-ons.
If you do so, when you want to upgrade your project, you can generate a new project using Cookieplone with the same name as your old one, and copy over your add-ons to the new project.
It is usually better and quicker to move your items into new locations and copy your dependencies than dealing with following the upgrade steps, regardless of whether you have modified the boilerplate.
```{seealso}
{ref}`upgrade-18-cookieplone-label`
```
````

(volto-upgrade-guide-18.x.x)=

Expand All @@ -41,6 +45,22 @@ This affects the way that the Plone Release Team generates the Sponsored OSS Doc

Since Volto `18.0.0-alpha.43`, the Docker image [`plone-frontend`](https://hub.docker.com/r/plone/plone-frontend) uses `pnpm`.

To migrate your projects to the new setup, take the following steps.

1. From the root of your project, create the new project structure with Cookieplone using the `frontend_addon` template using the following command.

```shell
pipx run cookieplone frontend_addon
```

1. Take the contents of the {file}`src` folder in the old structure, and copy them over to `packages/<your-addon-name>/src/`.

```{seealso}
- {doc}`../development/add-ons/create-an-add-on-18`
- [update for Volto 18 codesyntax/volto-maplibre-block#4](https://github.com/codesyntax/volto-maplibre-block/pull/4)
- [update for volto 18 codesyntax/volto-countup-block#5](https://github.com/codesyntax/volto-countup-block/pull/5)
```

For developers that won't migrate their projects to the new setup with `pnpm` instead of `yarn`, the Release Team will generate a new Docker image named `plone-frontend:18-yarn` for the Volto 18 series of alpha releases.
Support for `yarn` will be dropped in Volto 19.
Expand Down

0 comments on commit 4ea4f05

Please sign in to comment.