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

Opensource platform version #25

Merged
merged 6 commits into from
Dec 13, 2023
Merged
Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ select specific and compatible module versions and update each of them separatel
As all the modules add up to significant number, it might become a challenge to keep track of every module, their releases
and features, and to find the optimal combination of versions of all the needed modules.

This is, where the Pimcore Platform Version comes in. It is an additional enterprise service provided by Pimcore and
This is, where the Pimcore Platform Version comes in. It is an additional service provided by Pimcore and
provides a set of specific versions of all Pimcore modules which work together as they are compatible and explicitly
tested with each other and verified by Pimcore.

Expand Down Expand Up @@ -46,4 +46,4 @@ The versioning schema follows semantic versioning and is Major.Minor (e.g. 2023.
## Further Reads

- [Setup and working with Platform Versions](./doc/01_Setup.md)
- [Release Notes](./doc/02_Release_Notes/README.md)
- [Release Notes](doc/03_Release_Notes/README.md)
16 changes: 5 additions & 11 deletions doc/01_Setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,20 @@ On technical level, the Platform Version comes as a composer dependency and can
### Setup with existing project

Use following steps to setup Pimcore Platform Version in an existing project:
- Add Pimcore enterprise repository to project and setup authentication token (if not already done).
- Install platform version via `composer require pimcore/platform-version` and follow steps described
below to install further Pimcore modules.
- Install platform version via `composer require pimcore/platform-version` and follow steps described
below to install further Pimcore modules. Eventually you need to adapt versions of other
pimcore packages to apply to versions required by platform version. Please follow instructions of composer.

### Setup with new project

Use following steps to setup Pimcore Platform Version for a new project:
- Get skeleton via `composer create-project pimcore/skeleton my-project`.
- Rename `composer.enterprise.json` to `composer.json` (overwrite existing).
- Add/update your enterprise repository to the composer.json with `composer config repositories.enterprise composer https://repo.pimcore.com/<YOUR_REPOS>/`.
- Add your enterprise token to composer with `composer config --global --auth http-basic.enterprise.repo.pimcore.com token <YOUR_TOKEN>`
(if not already done).
- Install platform version via `composer require pimcore/platform-version`. Eventually you need to adapt versions of other
pimcore packages to apply to versions required by platform version. Please follow instructions of composer.
- Run `composer update` to install necessary additional requirements for Pimcore Platform Version and follow steps described
below to install further Pimcore modules.


:::info
`<YOUR_REPOS>` and `<YOUR_TOKEN>` you will get from your sales contact person at Pimcore.
:::

## Working with Platform Version

Once Pimcore Platform Version is set up, you can add included Pimcore modules with the matching version and update Pimcore
Expand Down
28 changes: 28 additions & 0 deletions doc/02_Platform_Version_Releases/2022.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# 2022.0 (LTS)

Following table lists all Pimcore modules and their version included in platform release 2022.0:

| Package Name | Included Version |
|-------------------------------------------------------| ---------------- |
| [pimcore/pimcore](https://github.com/pimcore/pimcore) | 10.6 |
| [pimcore/advanced-object-search](https://github.com/pimcore/advanced-object-search) | 5.0 |
| [pimcore/frontend-permission-toolkit-bundle](https://github.com/pimcore/frontend-permission-toolkit) | 1.5 |
| [pimcore/object-merger](https://github.com/pimcore/object-merger) | 3.0 |
| [pimcore/output-data-config-toolkit-bundle](https://github.com/pimcore/output-data-config-toolkit) | 4.1 |
| [pimcore/perspective-editor](https://github.com/pimcore/perspective-editor) | 1.6 |
| [pimcore/web2print-tools-bundle](https://github.com/pimcore/web2print-tools) | 4.0 |
| [pimcore/customer-management-framework-bundle](https://github.com/pimcore/customer-data-framework) | 3.4 |
| [pimcore/data-hub](https://github.com/pimcore/data-hub) | 1.6 |
| [pimcore/data-importer](https://github.com/pimcore/data-importer) | 1.8 |
| [pimcore/workflow-designer](https://github.com/pimcore/workflow-designer) | 1.1 |
| [pimcore/translations-provider-interfaces](https://github.com/pimcore/translations-provider-interfaces) | 3.0 |
| [pimcore/statistics-explorer](https://github.com/pimcore/statistics-explorer) | 2.0 |
| [pimcore/portal-engine](https://github.com/pimcore/portal-engine) | 3.1 |
| [pimcore/openid-connect](https://github.com/pimcore/openid-connect) | 1.1 |
| [pimcore/headless-documents](https://github.com/pimcore/headless-documents) | 2.0 |
| [pimcore/direct-edit](https://github.com/pimcore/direct-edit) | 2.0 |
| [pimcore/data-hub-simple-rest](https://github.com/pimcore/data-hub-simple-rest) | 2.0 |
| [pimcore/data-hub-productsup](https://github.com/pimcore/data-hub-productsup) | 1.3 |
| [pimcore/data-hub-file-export](https://github.com/pimcore/data-hub-file-export) | 2.0 |
| [pimcore/data-hub-ci-hub](https://github.com/pimcore/data-hub-ci-hub) | 1.2 |
| [pimcore/asset-metadata-class-definitions](https://github.com/pimcore/asset-metadata-class-definitions) | 2.0 |
36 changes: 36 additions & 0 deletions doc/02_Platform_Version_Releases/2023.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# 2023.1

Following table lists all Pimcore modules and their version included in platform release 2023.1:

| Package Name | Included Version |
|--------------------------------------------------------------------------------------------|------------------|
| [pimcore/pimcore](https://github.com/pimcore/pimcore) | 11.0 |
| [pimcore/newsletter-bundle](https://github.com/pimcore/newsletter-bundle) | 1.0 |
| [pimcore/ecommerce-framework-bundle](https://github.com/pimcore/ecommerce-framework-bundle) | 1.0 |
| [pimcore/web-to-print-bundle](https://github.com/pimcore/web-to-print-bundle) | 1.0 |
| [pimcore/google-marketing-bundle](https://github.com/pimcore/google-marketing-bundle) | 1.0 |
| [pimcore/personalization-bundle](https://github.com/pimcore/personalization-bundle) | 1.0 |
| [pimcore/file-explorer-bundle](https://github.com/pimcore/file-explorer-bundle) | 1.0 |
| [pimcore/system-info-bundle](https://github.com/pimcore/system-info-bundle) | 1.0 |
| [ppimcore/admin-ui-classic-bundle](https://github.com/pimcore/admin-ui-classic-bundle) | 1.0 |
| [pimcore/advanced-object-search](https://github.com/pimcore/advanced-object-search) | 5.0 |
| [pimcore/frontend-permission-toolkit-bundle](https://github.com/pimcore/frontend-permission-toolkit) | 2.0 |
| [pimcore/object-merger](https://github.com/pimcore/object-merger) | 4.0 |
| [pimcore/output-data-config-toolkit-bundle](https://github.com/pimcore/output-data-config-toolkit) | 5.0 |
| [pimcore/perspective-editor](https://github.com/pimcore/perspective-editor) | 1.6 |
| [pimcore/web2print-tools-bundle](https://github.com/pimcore/web2print-tools) | 5.0 |
| [pimcore/customer-management-framework-bundle](https://github.com/pimcore/customer-data-framework) | 4.0 |
| [pimcore/data-hub](https://github.com/pimcore/data-hub) | 1.6 |
| [pimcore/data-importer](https://github.com/pimcore/data-importer) | 1.8 |
| [pimcore/workflow-designer](https://github.com/pimcore/workflow-designer) | 1.1 |
| [pimcore/translations-provider-interfaces](https://github.com/pimcore/translations-provider-interfaces) | 3.0 |
| [pimcore/statistics-explorer](https://github.com/pimcore/statistics-explorer) | 2.0 |
| [pimcore/portal-engine](https://github.com/pimcore/portal-engine) | 3.0 |
| [pimcore/openid-connect](https://github.com/pimcore/openid-connect) | 1.1 |
| [pimcore/headless-documents](https://github.com/pimcore/headless-documents) | 2.0 |
| [pimcore/direct-edit](https://github.com/pimcore/direct-edit) | 2.0 |
| [pimcore/data-hub-simple-rest](https://github.com/pimcore/data-hub-simple-rest) | 2.0 |
| [pimcore/data-hub-productsup](https://github.com/pimcore/data-hub-productsup) | 2.0 |
| [pimcore/data-hub-file-export](https://github.com/pimcore/data-hub-file-export) | 2.0 |
| [pimcore/data-hub-ci-hub](https://github.com/pimcore/data-hub-ci-hub) | 1.2 |
| [pimcore/asset-metadata-class-definitions](https://github.com/pimcore/asset-metadata-class-definitions) | 2.0 |
39 changes: 39 additions & 0 deletions doc/02_Platform_Version_Releases/2023.2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# 2023.2

Following table lists all Pimcore modules and their version included in platform release 2023.2:

| Package Name | Included Version |
|--------------------------------------------------------------------------------------------|------------------|
| [pimcore/pimcore](https://github.com/pimcore/pimcore) | 11.0 |
| [pimcore/newsletter-bundle](https://github.com/pimcore/newsletter-bundle) | 1.0 |
| [pimcore/ecommerce-framework-bundle](https://github.com/pimcore/ecommerce-framework-bundle) | 1.0 |
| [pimcore/web-to-print-bundle](https://github.com/pimcore/web-to-print-bundle) | 1.0 |
| [pimcore/google-marketing-bundle](https://github.com/pimcore/google-marketing-bundle) | 1.0 |
| [pimcore/personalization-bundle](https://github.com/pimcore/personalization-bundle) | 1.0 |
| [pimcore/file-explorer-bundle](https://github.com/pimcore/file-explorer-bundle) | 1.0 |
| [pimcore/system-info-bundle](https://github.com/pimcore/system-info-bundle) | 1.0 |
| [ppimcore/admin-ui-classic-bundle](https://github.com/pimcore/admin-ui-classic-bundle) | 1.1 |
| [pimcore/advanced-object-search](https://github.com/pimcore/advanced-object-search) | 5.0 |
| [pimcore/frontend-permission-toolkit-bundle](https://github.com/pimcore/frontend-permission-toolkit) | 2.0 |
| [pimcore/object-merger](https://github.com/pimcore/object-merger) | 4.0 |
| [pimcore/output-data-config-toolkit-bundle](https://github.com/pimcore/output-data-config-toolkit) | 5.0 |
| [pimcore/perspective-editor](https://github.com/pimcore/perspective-editor) | 1.6 |
| [pimcore/web2print-tools-bundle](https://github.com/pimcore/web2print-tools) | 5.0 |
| [pimcore/customer-management-framework-bundle](https://github.com/pimcore/customer-data-framework) | 4.0 |
| [pimcore/data-hub](https://github.com/pimcore/data-hub) | 1.6 |
| [pimcore/data-importer](https://github.com/pimcore/data-importer) | 1.8 |
| [pimcore/workflow-designer](https://github.com/pimcore/workflow-designer) | 1.1 |
| [pimcore/translations-provider-interfaces](https://github.com/pimcore/translations-provider-interfaces) | 3.0 |
| [pimcore/statistics-explorer](https://github.com/pimcore/statistics-explorer) | 2.0 |
| [pimcore/portal-engine](https://github.com/pimcore/portal-engine) | 3.1 |
| [pimcore/openid-connect](https://github.com/pimcore/openid-connect) | 1.1 |
| [pimcore/headless-documents](https://github.com/pimcore/headless-documents) | 2.0 |
| [pimcore/direct-edit](https://github.com/pimcore/direct-edit) | 2.0 |
| [pimcore/data-hub-simple-rest](https://github.com/pimcore/data-hub-simple-rest) | 2.0 |
| [pimcore/data-hub-productsup](https://github.com/pimcore/data-hub-productsup) | 1.3 |
| [pimcore/data-hub-file-export](https://github.com/pimcore/data-hub-file-export) | 2.0 |
| [pimcore/data-hub-ci-hub](https://github.com/pimcore/data-hub-ci-hub) | 1.2 |
| [pimcore/data-quality-management-bundle](https://github.com/pimcore/data-quality-management-bundle) | 1.0 |
| [pimcore/data-hub-webhooks](https://github.com/pimcore/data-hub-webhooks) | 1.0 |
| [pimcore/backend-power-tools-bundle](https://github.com/pimcore/backend-power-tools-bundle) | 1.0 |
| [pimcore/static-resolver-bundle](https://github.com/pimcore/static-resolver-bundle) | 1.0 |
41 changes: 41 additions & 0 deletions doc/02_Platform_Version_Releases/2023.3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# 2023.3 (LTS)

Following table lists all Pimcore modules and their version included in platform release 2023.3:

| Package Name | Included Version |
|-------------------------------------------------------------------------------------------|------------------|
| [pimcore/pimcore](https://github.com/pimcore/pimcore) | 11.1 |
| [pimcore/newsletter-bundle](https://github.com/pimcore/newsletter-bundle) | 1.1 |
| [pimcore/ecommerce-framework-bundle](https://github.com/pimcore/ecommerce-framework-bundle) | 1.0 |
| [pimcore/web-to-print-bundle](https://github.com/pimcore/web-to-print-bundle) | 1.1 |
| [pimcore/google-marketing-bundle](https://github.com/pimcore/google-marketing-bundle) | 1.0 |
| [pimcore/personalization-bundle](https://github.com/pimcore/personalization-bundle) | 1.0 |
| [pimcore/file-explorer-bundle](https://github.com/pimcore/file-explorer-bundle) | 1.0 |
| [pimcore/system-info-bundle](https://github.com/pimcore/system-info-bundle) | 1.0 |
| [ppimcore/admin-ui-classic-bundle](https://github.com/pimcore/admin-ui-classic-bundle) | 1.3 |
| [pimcore/advanced-object-search](https://github.com/pimcore/advanced-object-search) | 5.0 |
| [pimcore/frontend-permission-toolkit-bundle](https://github.com/pimcore/frontend-permission-toolkit) | 2.0 |
| [pimcore/object-merger](https://github.com/pimcore/object-merger) | 4.0 |
| [pimcore/output-data-config-toolkit-bundle](https://github.com/pimcore/output-data-config-toolkit) | 5.0 |
| [pimcore/perspective-editor](https://github.com/pimcore/perspective-editor) | 1.7 |
| [pimcore/web2print-tools-bundle](https://github.com/pimcore/web2print-tools) | 5.0 |
| [pimcore/customer-management-framework-bundle](https://github.com/pimcore/customer-data-framework) | 4.0 |
| [pimcore/data-hub](https://github.com/pimcore/data-hub) | 1.6 |
| [pimcore/data-importer](https://github.com/pimcore/data-importer) | 1.8 |
| [pimcore/workflow-designer](https://github.com/pimcore/workflow-designer) | 1.1 |
| [pimcore/translations-provider-interfaces](https://github.com/pimcore/translations-provider-interfaces) | 3.0 |
| [pimcore/statistics-explorer](https://github.com/pimcore/statistics-explorer) | 2.0 |
| [pimcore/portal-engine](https://github.com/pimcore/portal-engine) | 3.1 |
| [pimcore/openid-connect](https://github.com/pimcore/openid-connect) | 1.1 |
| [pimcore/headless-documents](https://github.com/pimcore/headless-documents) | 2.1 |
| [pimcore/direct-edit](https://github.com/pimcore/direct-edit) | 2.0 |
| [pimcore/data-hub-simple-rest](https://github.com/pimcore/data-hub-simple-rest) | 2.0 |
| [pimcore/data-hub-productsup](https://github.com/pimcore/data-hub-productsup) | 1.3 |
| [pimcore/data-hub-file-export](https://github.com/pimcore/data-hub-file-export) | 2.0 |
| [pimcore/data-hub-ci-hub](https://github.com/pimcore/data-hub-ci-hub) | 1.2 |
| [pimcore/data-quality-management-bundle](https://github.com/pimcore/data-quality-management-bundle) | 1.1 |
| [pimcore/data-hub-webhooks](https://github.com/pimcore/data-hub-webhooks) | 1.0 |
| [pimcore/backend-power-tools-bundle](https://github.com/pimcore/backend-power-tools-bundle) | 1.1 |
| [pimcore/static-resolver-bundle](https://github.com/pimcore/static-resolver-bundle) | 1.2 |
| [pimcore/workflow-automation-integration-bundle](https://github.com/pimcore/workflow-automation-integration-bundle) | 1.0 |
| [pimcore/ee-admin-ui-classic-light-theme-bundle](https://github.com/pimcore/ee-admin-ui-classic-light-theme-bundle) | 1.0 |
13 changes: 13 additions & 0 deletions doc/02_Platform_Version_Releases/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Platform Version Releases

Following platform version releases are available.

| Version | Release Notes | Module Details | Is LTS | LTS support until |
|---------|------------------------------------------------|----------------------| ----- |--------------------|
| 2022.0 | - | [Details](2022.0.md) | ✅ | August 2025 |
| 2023.1 | [Release Notes](../03_Release_Notes/2023.1.md) | [Details](2023.1.md) | ❌ | - |
| 2023.2 | [Release Notes](../03_Release_Notes/2023.2.md) | [Details](2023.2.md) | ❌ | ❌ |
| 2023.3 | [Release Notes](../03_Release_Notes/2023.3.md) | [Details](2023.3.md) | ✅ | December 2025 |

Community support of a platform version ends after release of next platform version. LTS labeled platform versions and
their corresponding module versions have extended LTS support.
File renamed without changes.
File renamed without changes.
Loading