You are here

Home » API reference » Drupal 7 to 8/9 Module Upgrader 8

README.txt in Drupal 7 to 8/9 Module Upgrader 8 

CONTENTS OF THIS FILE
---------------------
 * Introduction
 * Usage
 * Running tests
 * Architecture
 * Maintainers


INTRODUCTION
------------

Drupal Module Upgrader is a script that scans the source of a Drupal 7 module,
flags any code that requires updating to Drupal 8/9, points off to any relevant
API change notices from https://www.drupal.org/list-changes/, and (where
possible) will actually attempt to *convert* the Drupal 7 code automatically to
the Drupal 8/9 version!

 * For a full description of the module, visit the project page:
   https://drupal.org/project/drupalmoduleupgrader
 * To submit bug reports and feature suggestions, or to track changes:
   https://drupal.org/project/issues/drupalmoduleupgrader


USAGE
-----

1. Install with composer (the site should already be using composer).

   composer require drupal/drupalmoduleupgrader
   drush en drupalmoduleupgrader

2. To scan the code and get a report of code that needs updating and how, run
   the following inside the Drupal 8/9 root directory (using Drush 8 or 9):

   drush dmu-analyze MODULE_NAME

   This will print a report showing any relevant change notices where you can
   read more.

3. To attempt to upgrade your Drupal 7 module's code to Drupal 8/9 
   automatically, run the following inside the Drupal 8/9 root directory:

   drush dmu-upgrade MODULE_NAME

   The script will output a few lines as it attempts various conversions. Go
   into your modules/MODULE_NAME directory and check out all of your new YAML
   files and such.

4. To clear out Drupal 7 code that has been converted, run the clean command:

   drush dmu-clean MODULE_NAME

   This will do things like delete old .info files and such, so you're closer to
   your port being completed!

RUNNING TESTS
-------------

In a Drupal site installed with composer and the Drupal Module Upgrader enabled,
run

  ./vendor/bin/phpunit -c core --group=DMU

ARCHITECTURE
------------

See the contributors documentation
https://www.drupal.org/documentation/modules/drupalmoduleupgrader/contributors

MAINTAINERS
-----------
Current maintainers:
 * Gábor Hojtsy - https://www.drupal.org/u/gábor-hojtsy

Past maintainers:
 * Adam (phenaproxima) - https://www.drupal.org/u/phenaproxima
 * Angela Byron (webchick) - https://www.drupal.org/u/webchick
 * Dan Feidt (hongpong) - https://drupal.org/u/hongpong
 * Jakob Perry (japerry) - https://www.drupal.org/u/japerry
 * Jess (xjm) - https://www.drupal.org/u/xjm
 * Lisa Baker (eshta) - https://www.drupal.org/u/eshta
 * Wim Leers - https://www.drupal.org/u/wim-leers

Special thanks to:
 * Cameron Zemek (grom358) - https://www.drupal.org/u/grom358 for all the
   pharborist help!

This project has been sponsored by:
* Acquia
  Dream It. Drupal It. https://www.acquia.com

This project has been supported by:
* PreviousNext
  Australia’s premium Drupal website consulting, design and development firm.
  http://www.previousnext.com.au/

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3.  * Introduction

  4.  * Usage

  5.  * Running tests

  6.  * Architecture

  7.  * Maintainers

  8. 

  9. 

  10. INTRODUCTION

  11. ------------

  12. 

  13. Drupal Module Upgrader is a script that scans the source of a Drupal 7 module,

  14. flags any code that requires updating to Drupal 8/9, points off to any relevant

  15. API change notices from https://www.drupal.org/list-changes/, and (where

  16. possible) will actually attempt to *convert* the Drupal 7 code automatically to

  17. the Drupal 8/9 version!

  18. 

  19.  * For a full description of the module, visit the project page:

  20.    https://drupal.org/project/drupalmoduleupgrader

  21.  * To submit bug reports and feature suggestions, or to track changes:

  22.    https://drupal.org/project/issues/drupalmoduleupgrader

  23. 

  24. 

  25. USAGE

  26. -----

  27. 

  28. 1. Install with composer (the site should already be using composer).

  29. 

  30.    composer require drupal/drupalmoduleupgrader

  31.    drush en drupalmoduleupgrader

  32. 

  33. 2. To scan the code and get a report of code that needs updating and how, run

  34.    the following inside the Drupal 8/9 root directory (using Drush 8 or 9):

  35. 

  36.    drush dmu-analyze MODULE_NAME

  37. 

  38.    This will print a report showing any relevant change notices where you can

  39.    read more.

  40. 

  41. 3. To attempt to upgrade your Drupal 7 module's code to Drupal 8/9 

  42.    automatically, run the following inside the Drupal 8/9 root directory:

  43. 

  44.    drush dmu-upgrade MODULE_NAME

  45. 

  46.    The script will output a few lines as it attempts various conversions. Go

  47.    into your modules/MODULE_NAME directory and check out all of your new YAML

  48.    files and such.

  49. 

  50. 4. To clear out Drupal 7 code that has been converted, run the clean command:

  51. 

  52.    drush dmu-clean MODULE_NAME

  53. 

  54.    This will do things like delete old .info files and such, so you're closer to

  55.    your port being completed!

  56. 

  57. RUNNING TESTS

  58. -------------

  59. 

  60. In a Drupal site installed with composer and the Drupal Module Upgrader enabled,

  61. run

  62. 

  63.   ./vendor/bin/phpunit -c core --group=DMU

  64. 

  65. ARCHITECTURE

  66. ------------

  67. 

  68. See the contributors documentation

  69. https://www.drupal.org/documentation/modules/drupalmoduleupgrader/contributors

  70. 

  71. MAINTAINERS

  72. -----------

  73. Current maintainers:

  74.  * Gábor Hojtsy - https://www.drupal.org/u/gábor-hojtsy

  75. 

  76. Past maintainers:

  77.  * Adam (phenaproxima) - https://www.drupal.org/u/phenaproxima

  78.  * Angela Byron (webchick) - https://www.drupal.org/u/webchick

  79.  * Dan Feidt (hongpong) - https://drupal.org/u/hongpong

  80.  * Jakob Perry (japerry) - https://www.drupal.org/u/japerry

  81.  * Jess (xjm) - https://www.drupal.org/u/xjm

  82.  * Lisa Baker (eshta) - https://www.drupal.org/u/eshta

  83.  * Wim Leers - https://www.drupal.org/u/wim-leers

  84. 

  85. Special thanks to:

  86.  * Cameron Zemek (grom358) - https://www.drupal.org/u/grom358 for all the

  87.    pharborist help!

  88. 

  89. This project has been sponsored by:

  90. * Acquia

  91.   Dream It. Drupal It. https://www.acquia.com

  92. 

  93. This project has been supported by:

  94. * PreviousNext

  95.   Australia’s premium Drupal website consulting, design and development firm.

  96.   http://www.previousnext.com.au/