steps to port your module in drupal.org when you have the d8 code ready

11
Drupal Geeks a Division of Ameex Technologies Corp 1701 E Woodfield Rd, Suite 211 Schaumburg, IL 60173 Steps To Port Your Module In Drupal.org When You Have the D8 Code Ready Introduction Once you have ported your module in Drupal 8 and have the code ready for D8, Then promote the D8 version in Drupal.org. Here we have the detailed information about the porting a module from drupal 7 to 8. Please follow the below steps to port. 1.Initial Steps a. Identify the module to be ported in Drupal 8 For instance I’ve chosen the “YoutubeChannel” module on drupal 7. i. Module URL https://www.drupal.org/project/youtubechannel b. Identify the owner of the project i. First sign in to drupal.org

Upload: drupalgeeks

Post on 20-Feb-2017

116 views

Category:

Technology


2 download

TRANSCRIPT

Drupal Geeks a Division of Ameex Technologies Corp 1701 E Woodfield Rd, Suite 211 Schaumburg, IL

60173

Steps To Port Your Module In Drupal.org When You Have the D8 Code Ready

Introduction

Once you have ported your module in Drupal 8 and have the code ready for D8, Then promote

the D8 version in Drupal.org. Here we have the detailed information about the porting a

module from drupal 7 to 8. Please follow the below steps to port.

1.Initial Steps

a. Identify the module to be ported in Drupal 8

For instance I’ve chosen the “YoutubeChannel” module on drupal 7.

i. Module URL

https://www.drupal.org/project/youtubechannel

b. Identify the owner of the project

i. First sign in to drupal.org

Drupal Geeks a Division of Ameex Technologies Corp 1701 E Woodfield Rd, Suite 211 Schaumburg, IL

60173

ii. At the top of the module’s page you can find the Author Name

iii. Click the author name to know the full details about the author

Drupal Geeks a Division of Ameex Technologies Corp 1701 E Woodfield Rd, Suite 211 Schaumburg, IL

60173

c. Identify whether the module is already ported or not

i. Goto the module page that is going to be ported in Drupal 8.

ii. It will display the version as 8.x if the module is ported in Drupal 8. If not, it is eligible to port

in Drupal 8. And Before proceeding to further steps we need to check whether any one is trying

to port.

iii. Note : check whether the module is already ported to Core or not

Drupal Geeks a Division of Ameex Technologies Corp 1701 E Woodfield Rd, Suite 211 Schaumburg, IL

60173

iv. If the module is ported already in Drupal 8, Don’t worry there are tons of modules are

waiting for you to port.

v. Here the modules list to be shown by most download by the user. Check the list and get it

from one. (http://drupalmodules.com/top-downloads)

2. Porting The Module To Drupal 8

First we need to install the dreditor tool(Optional) in the browser (https://dreditor.org/)

Advantage of dreditor tool - Dreditor is a great community tool that assists with things like

patch reviews, and generally interacting with the Drupal.org issue queue.

a. Create an issue queue

Create the issue queue for the following URL

https://www.drupal.org/project/issues/search/contrib_tracker

i. Now click on create new issue link as shown in screenshot

Drupal Geeks a Division of Ameex Technologies Corp 1701 E Woodfield Rd, Suite 211 Schaumburg, IL

60173

b. Status of the module and its content

Select the category, priority and status as shown in the screenshot

Drupal Geeks a Division of Ameex Technologies Corp 1701 E Woodfield Rd, Suite 211 Schaumburg, IL

60173

Category -> Plan

priority -> Minor

status -> Active

c. Template for the issue Queue

We have a static template style for issue summary block

Reference URL : https://www.drupal.org/issue-queue/how-to

My Template : https://www.drupal.org/node/2573659

Drupal Geeks a Division of Ameex Technologies Corp 1701 E Woodfield Rd, Suite 211 Schaumburg, IL

60173

If you have a file for drupal 8 then attach the file, otherwise you click on the save button.

3. Request The Author To Maintain The Module

Once created an issue send the request mail to owner(who developed the module) to add you

as a maintainer of that module.

a. Mail sample content

i. Goto top of the module page and click on the author name. It will display the contact

information of the author.

ii. Click the contact on top of the page

Drupal Geeks a Division of Ameex Technologies Corp 1701 E Woodfield Rd, Suite 211 Schaumburg, IL

60173

iii. Now fill the subject and message text box.

iv. Sample content for message text.

Hi XYZ,

I would like to port your module YoutubeChannel

(https://www.drupal.org/project/youtubechannel) to Drupal 8. I have created a Issue Queue

for porting this module D8 port issue queue link (https://www.drupal.org/node/2677758).

kindly add me as a maintainer so that I can commit my initial work and we can combine and

work on the further tweaks. I have ported the module I will upload the code as a patch kindly

review it.

Drupal Geeks a Division of Ameex Technologies Corp 1701 E Woodfield Rd, Suite 211 Schaumburg, IL

60173

Profile URL : https://www.drupal.org/u/jabastin.ameex

URL issue queue : Attach the issue queue for you are generated for

drupal8. https://www.drupal.org/node/2682735

My name : Jabastin Arul

User name : jabastin.ameex

4. Upload The Module As Patch

a. Clone the Drupal 7 module

i. At the top of the module’s page you can find the version control

ii. Click the version control, it will display the clone URL.

Drupal Geeks a Division of Ameex Technologies Corp 1701 E Woodfield Rd, Suite 211 Schaumburg, IL

60173

iii. Navigate to the folder in which you wish to install the module and run the command

iv. Start working on the cloned files to port

b. Applying a patch

i. Create patch

1. After your changes done in drupal 8, create a patch.

Description -> Your patch description

Issue-number -> Your issue queue number(see the step 2.a)

Comment-number -> Your posting commend number

Ex: for comment-number please see the screenshot below (This is our issue queue command

number)

Drupal Geeks a Division of Ameex Technologies Corp 1701 E Woodfield Rd, Suite 211 Schaumburg, IL

60173

ii. Applying a patch

1. After creating the patch then apply your patch to your selected module as shown in the

below screenshot.

After applying patch all the changes will be in your local. So push the changes into the

respective origin.(ex: git push origin your origin)

Conclusion

Drupal 7 have lot of modules. Those modules are till now not ported to Drupal 8. We need the

maintainer, Contributor to drupal 8 community. So this document may help you to port from

Drupal 7 to Drupal 8. And it's the best practice to you and your organization.

How We Can Help You?

For a thorough assessment and professional guidance on upgrading your Drupal

website, Drupal Geeks can be reached out @ 312-340-7112 or send an email

to [email protected]