openeuropa/oe_editorial

OpenEuropa Drupal module for editorial features.

2.4.0 2024-08-29 12:18 UTC

Requires

• php: >=8.0
• cweagans/composer-patches: ~1.4 || ^2
• drupal/core: ^10

Requires (Dev)

• composer/installers: ^1.5
• drupal/address: ^1.8
• drupal/config_devel: ^1.9
• drupal/content_lock: ^2.4
• drupal/core-composer-scaffold: ^10
• drupal/drupal-extension: ^5.0
• drupal/entity_version: ^1.1
• drush/drush: ^12
• mikey179/vfsstream: ^1.6.10
• nikic/php-parser: ^4.18
• openeuropa/behat-transformation-context: ~0.1
• openeuropa/code-review: ^2.0
• openeuropa/oe_link_lists: ^1.4
• openeuropa/oe_multilingual: ^1.13
• openeuropa/oe_paragraphs: ^1.19
• openeuropa/task-runner-drupal-project-symlink: ^1.0-beta6
• phpspec/prophecy-phpunit: ^2
• phpunit/phpunit: ^9.0
• symfony/phpunit-bridge: ^6.0

EUPL-1.2

README

This module provides editorial features for the OpenEuropa project.

Drupal 10 support.

Support for Drupal 10 will be added only in 2.x releases.

Upgrading from 1.x to 2.x

In 2.x, the support to Poetry has been dropped. In order to upgrade from 1.x to 2.x:

• uninstall oe_editorial_corporate_workflow_translation_poetry;
• upgrade to a 2.x release.

Development setup

You can build a development site using Docker and Docker Compose with the provided configuration.

Docker provides the necessary services and tools such as a web server and a database server to get the site running, regardless of your local host configuration.

Requirements:

• Docker
• Docker Compose

Configuration

By default, Docker Compose reads two files, a docker-compose.yml and an optional docker-compose.override.yml file. By convention, the docker-compose.yml contains your base configuration and it's provided by default. The override file, as its name implies, can contain configuration overrides for existing services or entirely new services. If a service is defined in both files, Docker Compose merges the configurations.

Find more information on Docker Compose extension mechanism on the official Docker Compose documentation.

Usage

To start, run:

docker-compose up

It's advised to not daemonize docker-compose so you can turn it off (CTRL+C) quickly when you're done working. However, if you'd like to daemonize it, you have to add the flag -d:

docker-compose up -d

Then:

docker-compose exec web composer install
docker-compose exec web ./vendor/bin/run drupal:site-install

Using default configuration, the development site files should be available in the build directory and the development site should be available at: http://127.0.0.1:8080/build.

Running the tests

To run the grumphp checks:

docker-compose exec web ./vendor/bin/grumphp run

To run the phpunit tests:

docker-compose exec web ./vendor/bin/phpunit

To run the behat tests:

docker-compose exec web ./vendor/bin/behat

Step debugging

To enable step debugging from the command line, pass the XDEBUG_SESSION environment variable with any value to the container:

docker-compose exec -e XDEBUG_SESSION=1 web <your command>

Please note that, starting from XDebug 3, a connection error message will be outputted in the console if the variable is set but your client is not listening for debugging connections. The error message will cause false negatives for PHPUnit tests.

To initiate step debugging from the browser, set the correct cookie using a browser extension or a bookmarklet like the ones generated at https://www.jetbrains.com/phpstorm/marklets/.

Contributing

Please read the full documentation for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the available versions, see the tags on this repository.