Release 3.0.0

[tuj]

Description

This release is a "maintenance" release that improves the developer experience and cleans up technical debt.

Features

• Gathered repositories (API, Admin, Client, Templates) into one.
• Removed remote-components for loading templates. Now they are included in the code.
• Reworked developer documentation.
• Prepared project for easier upgrades.
• Easier template and screen layout handling.

Linked Issues

• Improved developer experience #247
• Remove remote components #248
• OS2Display images in GitHub packages instead of Docker Hub #342

TODOs

CI

• GitHub actions for playwright tests
• Setup latest github actions from template

Developer setup

• Merge the code repositories into the API repository
• Remove remote components
• Better config handling through Symfony
• Release.json
• Vite 7.x with rolldown instead of rollup
• Fix hmr setup
• Setup admin tests with Playwright.
• Write template tests with Playwright
• Fix vite setup to make tests runnable in dev mode
• Taskfile

Documentation

• Unify changelogs
• Add ADR
• Developer docs
• Update docs with client configuration values
• Write upgrade guide 2.x -> 3.0
• Write how custom templates can be added.

Deployment

• Cleanup infrastructure
• Cleanup docker image builds
• Remove .docker/nginx.conf file

Dependencies

• Upgrade PHP dependencies.
• Dependencies: Replace quill (with https://tiptap.dev/docs ?)
• Dependencies: Replace lodash.set

Misc

• Simplify template install
• Integrate slide forms in admin instead of loading json files
• Fix rtx query caching handling.
• Update of api spec should update redux api slices as well.
• Remove PropTypes.
• Handle admin/access-config.json
• Handle client: online-check
• Create an update command that ensures migrations and templates are up to date.
• Evaluate how clients detect changes in release or config
• Refactor load screen layouts command
• Update with recent code changes
  • os2display/display-admin-client@9c05591...develop
  • os2display/display-templates@ac9c688...develop
• Rename os2display/display-api-service to os2display/display

Tasks after Release 3.0.0

• Dependencies: Upgrade javascript dependencies
• Fix random error in RelationsChecksumListenerTest.php test
• Cleanup frontend logging (pino). Is not configurable atm.
• Add admin form components for template content.
• Update display/docs documentation.
• Ensure the template styling is not affected by the styling from other parts of the page in the admin.
• Cleanup double feed caching.
• Look at Pentarion performance configuration options: https://symfony-vite.pentatrion.com/guide/performance.html#performance-%F0%9F%9A%80
• Update to Vite 8: https://vite.dev/blog/announcing-vite8-beta when not in beta anymore.
• Write client tests with Playwright.

Breaking changes

• External templates cannot be loaded anymore, since remote-components has been removed. An alternative is available
• All config.json files are not used anymore. All configuration should be set through .env
• All paths to the API are hardcoded in the client and admin.
• The clients use the same release.json file.
• Support for loading access config in Admin from admin/access-config.json has been removed.
• Renamed environment variables. See upgrade.md for instructions.

PRs

• WIP: Release/3.0.0 #251
• Gather code repositories into the API repository #250
• Changed to vite 7 and rolldown #252
• Added ADRs 008, 009 #253
• Github Actions cleanup #254
• Github Actions Playwright workflow #256
• Refactored how templates are handled #261
• Redux toolkit upgrade and fixed RTK Query caching setup #262
• Feature/5290 lint #264
• Added taskfile #265
• Updated developer docs #269
• Removed access-config.json fetch from Admin #270
• Online check #271
• Update command #272
• AGPL-3 #273
• Travel template tests #274
• Add vimeo test #275
• Add video test #276
• Table tests added, fixtures added, classes added to template #277
• 5365: rename grid to travel-grid #278
• Add fixture data and test of slideshow #279
• Align with 2.5.2. Cleaned up themes and fixtures. #287
• Added command to migrate config.json files to .env variables #288
• 5317: instagram template tests and changed slide fixtures #289
• Add contacts test #295
• Screen layout commands and expanded documentation #296
• 5317: remove acess config from tests #298
• 5317 fix failing campaign test #299
• Image text template tests #302
• 5317: rss template tests #303
• 5317: add template poster tests #304
• 5317 news template tests #305
• iframe template test #306
• 5317 template tests #307
• Calendar tests #308
• Booking calendar template #310
• Tests of hook #318
• update infrastructure for 3.0 #323
• Replace abandoned dependencies (lodash, react-quill) #337
• Align release/3.0.0 branch with changes to develop. #338
• Align environment variable names #339

[turegjorup]

@agnetemoos have added you here so you can track progress and contribute your input as needed

[agnetemoos]

I really like the to-do list—great idea!
I’ll keep an eye on it and add to it if I come across anything.