Composer is the new Drush - Drupal Developer Training (internal)
•
1 j'aime•687 vues
Drupal project codebase can and should be managed with Composer, as it provides better and more reliable results when building codebase. Drupal Console is replacing Drush -based workflows fast. Training 20.12.2016 by Perttu Ehn
Recommandé
Recommandé
Contenu connexe
Tendances
Tendances (20)
Similaire à Composer is the new Drush - Drupal Developer Training (internal)
Similaire à Composer is the new Drush - Drupal Developer Training (internal) (20)
Plus de Exove
Plus de Exove (20)
Dernier
Dernier (20)
Composer is the new Drush - Drupal Developer Training (internal)
- 1. Composer is the new Drush Perttu Ehn // Exove Ltd // 2106-12-20
- 2. Scope Drush Recap Composer Workflow with the Composer Recipes Semantic versioning More recipes Drupal Console
- 3. Perttu Ehn https://www.drupal.org/u/rpsu @ropsue Competence manager @ Exove Ltd www.exove.com 10 years of Drupal, three (small) contrib modules Motto: Q: Can this be done? A: Yes. Most certainly. It’s just a matter of the size of your budget. blah blah blah.. about me
- 5. Drush recap “Drush is a command line shell and Unix scripting interface for Drupal.“ - www.drush.org Build codebase based on the recipe (.make-file) $ drush make my-makefile.make Download and enable modules, themes Set variables, reset passwords, rebuild or revert features… Write your own custom commands to do practically anything with Drupal Drush is not a dependency manager, but a fixed recipe for the codebase
- 7. "Composer is a tool for dependency management in PHP" Dependency manager, per project, within a project Node: npm Ruby: bundler Composer
- 8. Composer does everything with the codebase Drush does, but better Composer Does not touch Drupal .. however, Drupal console does Composer
- 9. Workflow with the Composer
- 10. Set up a project repository (localdev…!) You add project requirements $ composer require drupal/drupal Composer will solve requirement's dependencies Commit composer.json and composer.lock -files to Git Don’t commit code hosted elsewhere - Drupal core, modules, libraries Workflow with the Composer
- 11. Use Composer template for Drupal, it comes with steroids! $ composer create-project drupal-composer/ drupal-project:8.x-dev coolio --stability dev —no-interaction --prefer-dist Workflow Image: http://www.e-steroid.com/steroid-articles/negative-effects-of-steroids.html
- 12. Use Composer template for Drupal $ composer create-project drupal-composer/ drupal-project:8.x-dev coolio --stability dev --no-interaction --prefer-dist Composer may be installed globally or per project1) Composer == composer.phar -file,“Php ARchive” Workflow 1) https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx
- 13. Use Composer template for Drupal $ composer create-project drupal-composer/ drupal-project:8.x-dev coolio --stability dev --no-interaction --prefer-dist create-project creates a new project from an existing project (think git clone) Workflow
- 14. Use Composer template for Drupal $ composer create-project drupal-composer/ drupal-project:8.x-dev coolio --stability dev --no-interaction --prefer-dist Use Composer template for Drupal as the base 8.x project version (relates to the Drupal core version) -dev use dev -version, ie. a git commit (latest one in this case) Workflow
- 15. Use Composer template for Drupal $ composer create-project drupal-composer/ drupal-project:8.x-dev coolio --stability dev --no-interaction --prefer-dist coolio is the directory where the project will be created also where composer.json and composer.lock files will be created Workflow
- 16. $ composer create-project drupal-composer/ drupal-project:8.x-dev coolio --stability dev --no-interaction --prefer-dist --stability dev Minimum stability of package --no-interaction Do not ask any interactive question Workflow
- 17. $ composer create-project drupal-composer/ drupal-project:8.x-dev coolio --stability dev --no-interaction --prefer-dist --prefer-dist Prefer distributions over source, ie. use vendor zip/gzip/tar/whatever if found. Faster. Workflow
- 20. $ composer create-project drupal-composer/drupal-project: 7.x-dev coolio-d7 --stability dev --no-interaction — prefer-dist … … (wait) … … (still working on it) … … Writing lock file Generating autoload files > rm README.md LICENSE .travis.yml phpunit.xml.dist $ cd coolio-d7 Ladies and gentleman, start your engines!
- 22. Web root is in coolio/web All libraries are protected from direct access coolio/vendor/* vendor code rarely needs to be accessible directly from the world index.php core/update.php (well...) Folder structure
- 23. Recipes
- 24. ; Drush INI core = 8.x api = 2 projects[drupal][version] = "8.2.3" projects[] = "ctools" projects[commerce][version] = "2.0-beta3" projects[commerce][subdir] = "commerce" defaults[projects][subdir] = "contrib" Recipes Get some modules (.make) List the modules you have with Drupal: $ drush pml Remove module code manually
- 25. # YAML format core: 8.x api: '2' projects: drupal: version: 8.2.3 ctools: version: '' #projects: commerce: subdir: commerce version: 2.0-beta3 defaults: projects: subdir: 'contrib' Recipes Get some modules (.make.yml) List the modules you have with Drupal: $ drush pml Remove module code manually
- 26. $ composer require drupal/core:8.2.2 Changes core version 8.2.3 -> 8.2.2 (with template project) $ composer require drupal/ctools $ composer require drupal/commerce:2.0-beta3 List the modules you have with Drupal: $ composer show drupal/* Remove a module - affects composer.json and the codebase, too $ composer remove drupal/ctools Add Drush and Registry Rebuild module (Drupal 7 only) $ composer add drush/drush:7.* drupal/registry_rebuild Recipes Get some modules (composer) zsh requires quoted parameter when it contains an asterisk: $ composer show "drupal/*"
- 27. You request a (Drupal) package $ composer require drupal/ctools Composer finds it (https://packages.drupal.org/8) Composer updates composer.json -file Composer downloads the package Composer checks if this new package has other requirements (composer.json file) Composer searches for the requirement… => this is a dependency tree! Composer dependency resolving 1/2 zsh requires quoted parameter when it contains an asterisk: $ composer show "drupal/*"
- 28. All good! && Write composer.lock file OR Exception!!! Exception!!! && Revert the changes in composer.json file Composer dependency resolving 2/2 zsh requires quoted parameter when it contains an asterisk: $ composer show "drupal/*"
- 29. 1. Clone project repository. 2. Run composer install Composer reads composer.lock -file Composer retrieves all the required dependencies Composer generates autoloader 3. That’s it! (+ some vagrant up and Drupal site installs) zsh requires quoted parameter when it contains an asterisk: $ composer show "drupal/*" Fellow developer’s local
- 30. Run composer update to get the latest available (version constraints!) Update code Write updates to composer.lock -file Change version (ie change version constraints) $ composer require drupal/commerce:2.* zsh requires quoted parameter when it contains an asterisk: $ composer show "drupal/*" How to do code updates?
- 32. Three digits; 1.2.3 1st changes might be backwards incompatible (major) API removals, API changes 2nd changes with API additions, new features (minor) 3rd changes with bug fixes (patch) Semantic versioning
- 33. Range Comparison operators, specified range of allowed versions >=1.0 >=1.0 <2.0 >=1.0 <1.1 || >=1.2 1.0 - 2.0 Wildcard * is a wildcard: 1.0.* is the equivalent of >=1.0 <1.1 https://getcomposer.org/doc/articles/versions.md Constraints
- 34. Tilde ~ specifies a minimum version, but allows the last digit specified to go up: ~1.2 is the equivalent of >= 1.2 < 2.* Caret ^ sticks closer to semantic versioning; sub-major version updates should not break anything: ^1.2.3 is equivalent to >=1.2.3 <2.0.0 https://getcomposer.org/doc/articles/versions.md Constraints
- 35. Specify allowed versions, not a specific version composer.lock -file will contain the specific version which composer install will use drupal/core:8.2.2 => drupal/core:~8.2 or drupal/ core:^8.2 drupal/commerce:2.0-beta3 => drupal/commerce:~2 drupal/ctools:~3 Git HEAD (not recommended): drupal/console:dev-1.x drupal/console:dev-master - for GitHub https://getcomposer.org/doc/articles/versions.md Constraints
- 36. More recipes
- 37. Problem: Feature or fix you must have may be in Git, but not in the latest release Solution: Use a specified Git commit More recipes
- 38. Use a specified Git commit ; Optionally provide git branch so Drush ; can write that to .info file projects[ctools][download][branch] = "8.x-3.x" ; Git commit hash projects[ctools][download][revision] = 1fe3649 More recipes
- 39. Use a specified Git commit projects: ctools: download: # Optionally provide git branch so # Drush can write that to .info file branch: 8.x-3.x # Git commit hash revision: 1fe3649 More recipes
- 40. Use a specified Git commit $ composer require drupal/ctools:dev-3.x#1fe3649 More recipes
- 41. Use a specified Git commit READ: never use HEAD (“latest whatever code”) More recipes
- 42. Problem: -> Found and fixed a bug in a contrib module, and now you need to use your fixes (a patch file) from drupal.org? No prob. -> Perhaps you were lazy and never uploaded the patch? No prob either. Solution: Drush and Composer can apply remote and local patches Patching modules
- 43. projects[field_group][version] = "1.0-rc4" ; Explain briefly why this patch is needed. projects[field_group][patch][2761159] = https:// www.drupal.org/files/issues/field_group- empty_group_nonnumeric_index-2761159-2-D8.patch ; Local patch (path relative to .make-file) projects[field_group][patch][other_fix] = patches/ field_group-fix_it.patch Apply the patch either by re-running $ drush make my_project.make …or manually $ patch -p0 < path/to/important.patch Patching modules
- 44. projects: field_group: version: '1.0-rc4' patch: # Explain briefly why this patch is needed. 2761159: 'https://www.drupal.org/files/issues/ field_group-empty_group_nonnumeric_index-2761159-2- D8.patch' # Local patch (path relative to .make.yml- file) other_fix: ‘patches/field_group-fix_it.patch' Apply the patch the same way with old style .make file Patching modules
- 45. Install module field_group $ composer require drupal/field_group:1.0-rc4 Edit composer.json and edit (or add) "extra": "extra": { "patches": { "drupal/field_group": { "A patch with URL”: “https://www.drupal.org/files/issues/ field_group-empty_group_nonnumeric_index-2761159-2-D8.patch", “Local patch (path relative to composer.json)”: "patches/ field_group-fix_it.patch" } } } Apply the patches and update composer.lock -file $ composer install # applies the patch $ composer update --lock # writes patch info to .lock file Patching modules
- 46. There is a module for that… but it requires an external library! As an example: Chosen -module is a wrapper for chosen-library Chosen library must be downloaded separately Other libraries Image: https://opensource.com/life/16/1/indiahacks-2016
- 47. projects[chosen] = “2.0-beta4" libraries[chosen][directory_name] = "chosen" libraries[chosen][type] = "library" libraries[chosen][download][type] = "get" libraries[chosen][download][url] = "https://github.com/ harvesthq/chosen/releases/download/1.4.2/chosen_v1.4.2.zip" Apply the patch either by re-running drush make my_project.make …or downloading the library manually Other libraries Image: https://opensource.com/life/16/1/indiahacks-2016
- 48. libraries: chosen: directory_name: chosen type: library download: type: get url: 'https://github.com/harvesthq/chosen/ releases/download/1.4.2/chosen_v1.4.2.zip' Apply the patch the same way with old style .make file Other libraries Image: https://opensource.com/life/16/1/indiahacks-2016
- 49. Manually add new item to your repository -section in composer.json: "repositories": [{ "type": “package", "package": { "name": "customlibs/chosen", "version": "master", "dist": { "type": "zip", "url": "https://github.com/harvesthq/chosen/releases/download/1.4.2/ chosen_v1.4.2.zip", "reference": “1.4.2" }, "autoload": { "classmap": ["."] } }], Request the library $ composer require customlibs/chosen:1.4.2 Then update your packages as per what you've just done: $ composer update NOTE: Chosen modules declares this dependency in Drupal 8 version via composer.json Other libraries Image: https://opensource.com/life/16/1/indiahacks-2016
- 50. Drupal Console
- 51. Briefly about Drupal Console Composer manages (Drupal) codebase Drupal Console does tricks with Drupal itself (Drupal 8) Help your self by aliasing drupal if it is not in your $PATH #localdev VM bash alias is alias drupal="/vagrant/drupal_root/vendor/ drupal/console/bin/drupal"
- 52. Site installation Install Drupal site (default -folder) $ drupal site:install minimal --langcode="en" --db-type="mysql" --db-host="127.0.0.01" --db-port="3306" --db-name="local_1" --db-user="root" --db-pass="root" --site-name="Drupal 8" --site-mail="admin@example.org" --account-mail="admin@example.org" --account-name="admin" --account-pass="admin" --no-interaction --learning -vvv
- 53. Site installation Install Drupal site (default -folder) $ drupal site:install minimal --no- interaction Command aliases ❤ $ drupal si
- 54. Multisite installation 1. Create multisite folder and directory aliasing file sites/ sites.php $ drupal multisite:new example.com --site-uri=“local-2.example.com” > creates sites/example.com -folder > creates site-alias local-2.example.com => sites/ example.com 2. Install the site $ drupal si minimal --uri="local-2.example.com" --no-interaction
- 55. Multisite tools Check multisite structure $ drupal multisite:debug Clone (!) existing default site to a multisite folder $ drupal multisite:new --copy-install --site-uri="local2.example.com" example.com
- 56. Module commands Install a module $ drupal module:install | mou Uninstall a module $ drupal module:uninstall | mou Generate module $ drupal generate:module | gm Rebuild D8 cache $ drupal cache:rebuild | cr
- 57. Some random commands Go nuts! $ drupal [-l=local-1.example.com] list $ drupal [--uri=local-1.example.com] list Get help! $ drupal help [topic] Documentation https://drupalconsole.com/docs , also in Vietnamese and Hindi among some other languages NOTE: Drupal Console v1.0.0-rc12 (not yet released) is needed for properly working (automated) multisite installation process
- 58. Questions?
- 59. Questions? Drush Recap Composer Workflow with the Composer Recipes Semantic versioning More recipes Drupal Console
- 60. Take also look at these Composer template for Drupal projects https://github.com/drupal-composer/drupal-project Improving your Drupal 8 development workflow by Jesus Manuel Olivas http://weknowinc.com/talks/2016/drupalgov-workflow Drupal Console Docs https://drupalconsole.com/docs