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

[Task] Add caution section for compose require #41

Merged
merged 4 commits into from
Nov 5, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion doc/01_Setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Bugfix versions of Pimcore modules can be installed within a Platform Version vi

- Carefully read our [Release Notes](./03_Release_Notes/README.md) before any update.
- Update to a new Pimcore Platform version:
- if you want to stick to a specific version, use the command `composer require pimcore/platform-version:2023.1`.
- if you want to update to a specific version, use the command `composer require pimcore/platform-version:2023.1 --no-update` to update your `composer.json`. Afterwards run `composer update`.
- if you want to update to the latest version (and the constraint in your `composer.json` allows further updates),
use the command `composer update pimcore/platform-version`.

Expand All @@ -54,6 +54,16 @@ Eventually adding `pimcore/*` is necessary for composer to resolve pimcore repos

:::

:::caution

Keep in mind that the `pimcore/platform-version` repository does not specify required packages.
It only specifies conflicting packages to ensure compatible versions are installed.
The command `composer require pimcore/platform-version --update-with-all-dependencies` will therefore not work.
The command `composer require` will check against your `composer.lock` and may result in an error.
You need to run `composer update` to update all packages to the latest version.

:::

:::warning

It might be necessary to update a specific Pimcore module to a version that is not included in the Platform Version.
Expand Down
Loading