Skip to main content

Best Way to use composer with drupal in multi environment(dev,stage,prod)


NOTE :  it’s extremely important that your development environment is using the same version of PHP that the target production environment will use. Otherwise Composer may download packages that won’t work in production.

  (With larger development teams, using something like Vagrant or Docker for local development can help ensure compatibility between local development instances and the production stack

How do I download modules and themes:

1 - composer require drupal/devel 
it would download the module to web/modules/contrib. If you want to change the download destination, you can alter the paths in your composer.json. 

Development Dependencies:

composer require --dev drupal/devel
 For example, since the Devel module shouldn’t be used in a production environment, you may only want it to get downloaded on development environments. With Composer, you can achieve this by passing the --dev flag to the composer require command.

 This will ensure that the Devel module is available for your developers when they run composer install in our system, but that it won’t ship with your production release (which should get built using composer install --no-dev ). This is just an example, and your project needs may differ, but the use of --dev to specify dependencies only needed during development is a recommended best practice.

What do I commit?

You may have noticed that after running some of the above composer commands, Composer created a composer.lock file in your repository. The composer.lock file is a very important file that you want to commit to your repository anytime it changes. 

 When you require a new package, you may have omitted a version or a version constraint, but Composer downloaded a specific version. That exact version is recorded in the composer.lock file, and by committing it to your repository, you then ensure that anytime composer install is run on any other environment, the same exact code gets downloaded. That is very important from a project stability standpoint.

List of files commit and what not to commit:

  1. Commit composer.json and composer.lock anytime they change.
  2. There’s no need to commit anything in 
  3. ./vendor , 
  4. Drupal core (./web/core), 
  5. contributed modules and themes (./web/modules/contrib or ./web/themes/contrib), not recommended we can ignore it if only all the modules & themes is managed by composer and I will install it on another environment with composer install, 
specific PHP version for Composer to adhere to in composer.json
composer config platform.php 7.1
Once added, don’t forget to update your lock file and
commit the resulting composer.json and composer.lock .

composer update --lock

Some Usefull composer commands :
composer update --with-dependencies drupal/devel
composer update --with-dependencies drupal/foo drupal/bar
composer update --with-dependencies drupal/*
composer remove drupal/devel



 Ref: https://www.lullabot.com/articles/drupal-8-composer-best-practices

Labels:

Comments

Post a Comment

Popular posts from this blog

Get The field values of node in Drupal 8

use Drupal \ node \ NodeInterface ; /** * Implements hook_ENTITY_TYPE_insert() for node entities. * * This tests saving a node on node insert. * * @see \Drupal\node\Tests\NodeSaveTest::testNodeSaveOnInsert() */ function node_test_node_insert ( NodeInterface $node ) { // Set the node title to the node ID and save. if ( $node - > getTitle ( ) == 'new' ) { $node - > setTitle ( 'Node ' . $node - > id ( ) ) ; $node - > setNewRevision ( FALSE ) ; $node - > save ( ) ; } } Now There is so many functions are there to get the values, For All the functions available visit the API code, https://api.drupal.org/api/drupal/core%21modules%21node%21src%21NodeInterface.php/interface/NodeInterface/8.2.x Some of as below, Node edit form, Drupal 8 Automatically Load the whole object no need to load the entity like below, if ($event->getFormId() == 'node_alexa_audio_clips_edit_form') { $node = \Drupal::ro...
Post a Comment
Read more

Drupal Setup with docker

Option 1:  docker pull mysql docker pull phpmyadmin docker pull drupal docker run -d --name MysqlClient -e MYSQL_ROOT_PASSWORD=drupal mysql Download the phpmyadmin image and Setup Container: docker run --name phpmyadmin -d --link MysqlClient:db -p 8083:80 phpmyadmin Download the Drupal image and Setup Container: docker run -d --name dweb2 --link MysqlClient -p 8082:80 -e MYSQL_USER:root -e MYSQL_PASSWORD:drupal drupal   We are using docker4 drupal and following below URL https://wodby.com/docs/1.0/stacks/drupal/local/ From Mount my codebase Download and unpack docker4drupal.tar.gz with hidden files in a new directory, also get the drupal code with in web directory composer create - project drupal / recommended - project my_site_name_dir It means with in new directory we have docker files and drupal files also has web folder for drupal. now run docker-compose up -d Now PROJECT_BASE_URL is mentioned in .env file open this url in the web with port, it will open the drupal page, ...
Post a Comment
Read more