El objetivo de este post es explicar, desde un punto de vista práctico, el procedimiento que debemos seguir si queremos contribuir con la comunidad de Drupal con una funcionalidad específica que hayamos desarrollado previamente. O dicho de otra forma, cómo podemos contribuir con nuestro módulo a la comunidad.

Para ello, y aunque tengamos ciertas prisas en ver nuestro flamante módulo subido a Drupal.org y disponible para su descarga por parte de otros usuarios, debemos ser conocedores de las políticas y procedimientos de publicación, especialmente desde la publicación de la versión 8 de Drupal, que ha acarreado cambios importantes en los procesos involucrados en la aceptación y publicación de un módulo.

 

SECURITY ADVISORY OPT-IN

En versiones anteriores de Drupal, para la publicación directa de un módulo necesitábamos previamente la revisión y valoración por parte de miembros de la comunidad de nuestro código, de forma que existieran ciertas garantías provenientes del criterio de usuarios experimentados y evitar así que el repositorio de módulos contribuidos se convirtiera en un peligroso cajón de código poco eficiente.

Esto tenía un inconveniente importante: a veces este proceso se demoraba en el tiempo, penalizando el incremento de módulos contribuidos por parte de usuarios. Además, en ocasiones, ocurría que durante este proceso de revisión se creaban módulos con funcionalidades similares, ya que en el momento de su escritura por parte de otros usuarios no existían módulos disponibles por estar aún en la cola de espera. Para evitar esto, se creó la Security Advisory Opt-in.

Básicamente, este nuevo sistema consiste en un proceso más permisivo de publicación. Se permite la difusión y descarga de forma directa por parte de los usuarios desarrolladores. Aunque a priori parezca que se evita el sistema de revisión pertinente que garantizaba la calidad y eficiencia de los desarrollos, queda reflejado en la ficha de cada módulo publicado si este ha sido revisado por parte de usuarios experimentados en la comunidad. En caso no ser así, aparece este mensaje:

 

En el momento de publicación de este post, podemos ver varios ejemplos:

Sin embargo, si accedemos a la ficha de descarga de módulos que sí han pasado este proceso de revisión, o su creador ya había pasado previamente por este proceso en otro módulo anterior, lo vemos reflejado con el siguiente símbolo:

 

Algunos ejemplos de módulos sobradamente conocidos son:

Más adelante ampliaremos información sobre los procesos necesarios a seguir para superar este proceso y que nuestro módulo cuente con nuestro sello de calidad. Ahora, suponiendo que ya tenemos nuestro código fuente listo para su publicación, ¡entremos en materia!

 

BECOME A ‘CONFIRMED’ USER

En primer lugar, como no podía ser de otra forma, tenemos que crearnos un perfil en Drupal.org.

Al igual que existe una política de publicación de módulos, para evitar el uso indiscriminado de spam por parte de robots en Drupal.org, existe una política de validación del perfil de los usuarios. De esta forma, tenemos que conseguir el rol “Usuario confirmado” antes de seguir con nuestro proceso de publicación.

No es un proceso complejo, simplemente basta con postear algún contenido en Drupal.org y los robots de Drupal se encargarán de asignarnos el rol directamente. Tienes más información aquí.

 

OBTAINING GIT ACCESS

Antes de subir código fuente al repositorio de Drupal, necesitamos acceso al propio Git. Para ello, basta con seguir estas instrucciones.

 

PUBLICANDO NUESTRO CÓDIGO FUENTE

Es importante hacer un ejercicio de reflexión antes de publicar nuestro primer módulo:

  • ¿Existe un módulo parecido que haga algo similar a lo que voy a publicar?
  • ¿He comprobado si más que un módulo, estoy desarrollando una funcionalidad adicional a un módulo ya existente? De ser así, a lo mejor es más interesante hacerme co-maintainer de un módulo ya existente. Aquí puedes encontrar más información al respecto.

 

SANDBOX

Para la publicación de nuestro módulo, tenemos dos caminos diferentes:

  1. Creación de un Sandbox que nos permite testear nuestro código sin necesidad de que éste se publique directamente en la comunidad. Este es el camino recomendado antes de convertir nuestro módulo en Full Project.
  2. Full Project. De esta forma, nuestro módulo quedaría expuesto directamente a la comunidad para su descarga de forma inmediata. Si no estamos completamente seguros de que nuestro módulo haya pasado todos los criterios de validación necesarios, evitaría este camino.

Una vez que tenemos claro que nuestro camino pasa por crear previamente un Sandbox, accedemos directamente a la URL de publicación del mismo.

En este formulario nos solicitarán información sobre el módulo: nombre, descripción, tipo de proyecto (es importante que, de momento, indiquemos que se trata de un Sandbox), categoría, tipo de mantenimiento, etc.

 

Una vez hayamos completado el formulario de creación de nuestro Sandbox, estamos listos para subir nuestro código. Para ello, sin entrar en profundidad, hacemos clic en la pestaña ‘Version Control’ de nuestro Sandbox, donde encontraremos información detallada sobre los comandos necesarios para pushear nuestro código al repositorio de Drupal:

Si no tienes claro el sistema de convenciones utilizado por Drupal.org para el versionado de tu módulo, puedes ampliar más información aquí.

 

 

FULL PROJECT

Durante el proceso de conversión de Sandbox a Full Project, debemos asegurarnos, entre otras cuestiones, que la calidad de nuestro código cumpla con el coding standard de Drupal. Además debe cumplir otro tipo de requisitos como las instrucciones de instalación, la descripción detallada de la funcionalidad que lleva a cabo nuestro módulo, etc.

Para ello, podemos hacer uso de varias herramientas.

La herramienta pareview.sh se encargará de revisar el coding standard y las buenas prácticas de Drupal, simplemente con indicar el repositorio Git de nuestro Sandbox, mostrando los posibles errores encontrados mediante un informe. Esta herramienta utiliza Code Sniffer para analizar el código PHP, haciendo uso de las métricas de Drupal incluidas en la herramienta Coder.

Si estamos seguros de que hemos cumplido con todos los requisitos indicados anteriormente y estamos listos para publicar nuestro módulo, es hora de convertir nuestro Sandbox en Full Project. Para ello, editamos nuestro Sandbox:

 

Y hacemos clic en la pestaña ‘Promote’:

 

Completamos el formulario asegurándonos de ingresar un nombre corto para nuestro módulo. Este nombre se usará para construir la URL: drupal.org/project/[short name]. En los módulos de sandbox, el nombre abreviado será el ID del proyecto. Así que es importante que este nombre sea descriptivo de la funcionalidad que cumple nuestro proyecto.

Una vez que nuestro Sandbox ha sido promocionado, el repositorio de código pasa de /sandbox/username/123456.git a project/project_name.git. Esto implica que tengamos que hacer de nuevo un clone de nuestro proyecto en nuestro entorno local si queremos seguir haciendo modificaciones del código.

Es hora de ver con qué tipo de release queremos salir a “producción”. Para ello, en Drupal podemos distinguir tres tipos de releases oficiales (las releases de desarrollo quedan para las versiones inestables que están actualmente en evolución por parte de los mantenedores):

  • Versión recomendada. En este caso, el mantenedor del proyecto (o sea, nosotros) considera que esta es la versión más estable para su descarga.
  • Release soportada. Para aquellos casos en los que el desarrollador piensa que es posible que no sea la mejor opción, ya sea porque la release es o muy nueva o muy antigua.
  • Versión no soportada. Por alguna razón, el mantenedor del módulo ha considerado que no es la versión más apropiada.

Aquí tienes más información sobre los tipos de release.

Así que vamos a crear nuestra primera release. Una vez la completemos, podremos decidir si pasarla a una release oficial o bien seguimos en la versión de desarrollo porque queramos seguir evolucionando el módulo. En cualquier caso, primero es necesario que creemos un tag con la release adecuada y la pusheemos a nuestro repositorio de Git de Drupal.org.

 

CREANDO NUESTRA RELEASE OFICIAL

En la ficha de nuestro Full Project, hacemos clic en la pestaña ‘Version control’ y seguimos las instrucciones indicadas en ‘Tag for a stable release’.

Una vez que hemos realizado el push de nuestra release, volvemos a la página principal de nuestro proyecto y hacemos clic en ‘Add new release’ (abajo del todo):

 

Si el nombre del tag creado ha seguido las convenciones comentadas anteriormente, el sistema nos pedirá la naturaleza de la release (New Feature, Bug, etc.). Damos a guardar y tendremos listo nuestro primer archivo descargable para su uso (ten en cuenta que el sistema puede tardar hasta 12 horas en disponer del archivo y, por lo tanto, del enlace para su descarga, así que no hay que impacientarse en este punto).

Además, recientemente se ha cambiado la política de publicación de releases, y ahora únicamente aparecen para su descarga directa las releases estables (y no las de desarrollo). Si quieres que aparezcan también las release de desarrollo, haz click en ‘Show in project’s download table when branch is supported’.

Desde este momento, ya tenemos nuestro primer módulo publicado y listo para su descarga por parte de terceros. Sin embargo, y para nuestra desgracia, vemos que nuestro módulo no está cubierto por la Security Advisory Policy. ¿Recordáis la política de publicación con la que hemos empezado este artículo? Pues bien, es hora de intentar conseguir nuestro sello.

 

SECURITY ADVISORY POLICY

Hay que tener en cuenta que esta marca solo afecta a versiones estables (ni alpha, ni beta, ni RC). Para aplicar el sello de “seguridad”, en la edición del proyecto hay que activar la opción ‘opt-in’, sin embargo no vamos a poder si no tenemos el rol adecuado (git vetted role).

Para obtener los permisos y poder acceder a esta opción, un administrador de Git de Drupal debe concedérnoslo. Para ello, debemos crear una issue de revisión que servirá para que otros usuarios puedan revisar nuestro módulo y marcarlo como apto. Aquí puedes seguir las instrucciones precisas para hacerlo.

Cuando un miembro de la comunidad nos marque el proyecto como RTBC. nuestro proyecto entrará en una lista de revisión para que un administrador nos conceda el rol vetted user y así poder marcar nosotros mismos nuestros proyectos como ‘opt-in’.

Existen dos listas de revisión de módulos:

  • Lista normal. Tarda muchísimo en ser evaluada por la comunidad (meses o años)
  • Lista prioritaria. Para acceder a esta lista tenemos que acceder al programa Review Bonus.

 

REVIEW BONUS

Si queremos priorizar nuestro post de revisión y garantizar que nuestro módulo obtiene el sello de calidad lo antes posible, tenemos que empezar a contribuir en la comunidad, y qué mejor que hacerlo a través del programa Review Bonus de Drupal.org.

Este programa consiste básicamente en ayudar a la comunidad de voluntarios de Drupal.org a revisar módulos de otros contribuidores que se encuentran en una situación similar a la nuestra. De esta forma, el sistema de Review bonus nos invita a revisar, al menos, hasta 3 módulos de otras personas que están en un proceso similar. De esta forma podemos encontrar los mismos fallos de seguridad en el código que podrían encontrar en nuestro módulo.

Debido a que el proceso de solicitud es completamente voluntario, muchos de los revisores más activos usan el programa Review Bonus para priorizar qué módulos revisan. Este programa le da prioridad a aquellos que también están ayudando a revisar otras aplicaciones.

Para comenzar el proceso de revisión de un módulo, accedemos a la ‘Lista normal’ mencionada anteriormente. Existe una plantilla que podemos tener como referencia para saber qué tenemos que revisar. Cada vez que encontramos algún error en alguno de los módulos de esta lista, realizamos un post en el hilo, copiamos la URL de nuestro post y lo referenciamos en el body del post de revisión que hemos creado para que nos validen nuestro propio módulo.

Una vez que hayamos revisado y referenciado tres incidencias en nuestro post de revisión del módulo, editamos nuestro propio post y le añadimos el tag ‘PAReview: review bonus’ en el campo ‘Issue Tags’ en el formulario de comentarios de nuestro post. Desde este momento, nuestro post de revisión estará en la lista prioritaria.

Aquí tenemos un post de ejemplo de un desarrollador que ha revisado a su misma vez otros tres posts. De esta forma podemos ver la estructura que debería tener nuestro post de revisión.

Finalmente, algún administrador de la comunidad de Drupal revisará nuestro módulo y nos concederá el rol necesario para que podamos conceder nosotros mismos los sellos de seguridad a los módulos que desarrollemos a partir de ahora sin tener que volver a pasar por este proceso.

 

DRUPAL EN SDOS

Desde SDOS impulsamos el desarrollo y la contribución a la comunidad a través de nuestros equipos multidisciplinares, estableciendo metodologías ágiles de desarrollo y siendo fieles tanto al coding standard establecido a través de la comunidad de Drupal como a sus buenas prácticas de desarrollo. Así mismo, en SDOS estamos comprometidos con la comunidad, colaborando con la Drupal Association y apostando por los diferentes eventos desarrollados a nivel nacional.