Reporte de equipo: generar con Maven

En maven existe un excelente plugin para generar la documentación incluido un reporte de equipo, de manera automatizada, para un proyecto de software desde la información presente en el archivo pom.xml.

Configuración básica

El plugin se llama maven-project-info-reports-plugin y para agregarlo en la sección raíz deberemos de agregar la etiqueta reporting y nuestro plugin como sigue:

<reporting>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-project-info-reports-plugin</artifactId>
                <version>2.9</version>
            </plugin>
        </plugins>
</reporting>

Si tuvieras otros plugins que generen reportes puedes incluirlos sin problemas ya que no te causarán conflictos.

En la raíz de nuestro archivo pom agregamos la información del reporte. En este caso concreto me agregaré como desarrollador, especificando mi nombre, correo electrónico y rol. Si tienes más de un rol puedes crear una entrada por cada uno de ellos.

<developers>
        <developer>
            <name>Ruslan López Carro</name>
            <email>micorreo@javapro.org</email>
            <roles>
                <role>Software Designer</role>
            </roles>
        </developer>
</developers>

Deberás de hacer esto por cada desarrollador y miembros del equipo.

Agregar foto de los miembros del equipo

Para que nos salga una imagen junto con cada miembro del equipo deberemos de agregar la propiedad llamada picUrl de la siguiente manera:

    <developers>
        <developer>
            <name>Ruslan López Carro</name>
            <email>micorreo@javapro.org</email>
            <roles>
                <role>Software Designer</role>
            </roles>
            <properties>
                <picUrl>
                    https://lh3.googleusercontent.com/-veL0tE86fn4/AAAAAAAAAAI/AAAAAAAAAAA/ANQ0kf7mAvM6bBQK5E50MgHG9NUFnk5vIg/s64-c-mo/photo.jpg
                </picUrl>
            </properties>
        </developer>
    </developers>

como podrás ver en este caso estamos usando una url de internet, esta podría ser parte de tu página de empelados, o algo similar, pero mi recomendación es usar la foto de tu gravatar o de tu LinkedIn.

En cuanto al correo depende, si es un proyecto open source, te recomiendo poner un correo en el que te puedan contactar para pedir soporte, pero con le truco de ponerlo con el formato

micorreo [at] dominio.com

Esto para evitar que los bots que revisan el internet minen tu correo.

Si el proyecto es para una empresa, usa el correo corporativo, esto con la idea de que si tuvieran problemas con la aplicación como allí viene el correo corporativo pueden usarlo para obtener tus datos de contacto solicitándolos a recursos humanos y solicitarte que les proveas el soporte técnico como consultor.

Reporte de equipo terminado

Para obtener el reporte la manera más fácil es correr el comando

mvn site

Esto debido a que el plugin de reportes de maven se ejecuta en esta fase

El resultado final se verá así:

Como podrás ver, aunque parece una banalidad, permitirá que la gente pueda contratarte, por lo que vale la pena agregar esta sencilla configuración a tus proyectos.