/ Shields.io

Shields.io - Enriqueciendo el readme.md

¡Hola a todos! Hoy vengo a hablar de esos iconos que vemos muchas veces en los readme de GitHub que indican cosas como el número de descargas, el estado de la build, la cobertura de los tests, etc.

Esto no es ni más ni menos que Shields.io.

Cómo funciona Shields.io

Shields es una plataforma que nos ofrece una serie de etiquetas para añadir en nuestros readme o webs que nos ofrece información de distinto ámbito.

El funcionamiento es muy sencillo. Esta web nos ofrece una imagen generada con la información obtenida de diferentes fuentes de datos como Twitter, Github, VSTS, etc.

Por ejemplo podemos poner una etiqueta con los seguidores en Twitter.

Twitter Follow

Esto es básicamente una imagen generada con una serie de parámetros en la URL.

// Formato
https://img.shields.io/twitter/follow/USER_TWITTER.svg?style=social&label=Follow

Para añadirlo en el markdown podemos crear un enlace que contenga como contenido esta imagen y apunte a nuestro twitter.

[![Twitter Follow](https://img.shields.io/twitter/follow/maktub82.svg?style=social&label=Follow)](https://twitter.com/maktub82)

// Siguiendo este formato
![ [alt_image](url_image_shields_io) ](url_enlace)

De esta forma podemos añadir cualquier etiqueta de Shields en nuestros markdowns. Ahora vamos a ver alguna de las opciones que nos ofrece.

Build

Shields nos ofrece etiquetas para diferentes plataformas de Build.

Travis

![Travis](https://img.shields.io/travis/USER/REPO.svg)

![Jenkins](https://img.shields.io/jenkins/s/https/jenkins.qa.ubuntu.com/view/Precise/view/All%20Precise/job/precise-desktop-amd64_default.svg)

![Magnum CI](https://img.shields.io/magnumci/ci/96ffb83fa700f069024921b0702e76ff.svg)

Cómo configurarlo en VSTS

Para poder configurar esta etiqueta de Build en VSTS tenemos que ir a la configuración de la build y activar la opción de Badge.

![Visual Studio Team Services](https://img.shields.io/vso/build/TEAM_NAME/PROJECT_ID/BUILD_DEFINITION_ID.svg)

VSTS Badge

Al pulsar sobre Show url... podemos obtener los parámetros de la URL para rellenar los datos necesarios en Shields.

VSTS Badge

Cobertura de código

Además de ofrecer el estado de la Build nos ofrecen la cobertura de código para muchas plataformas como Jenkins, Codecov, TeamCity, etc.

Jenkins coverage

Downloads

Otra de las etiquetas que podemos poner es el número de descargas. De nuevo, está disponible en múltiples plataformas.

NuGet

Algunas de las plataformas disponibles son GitHub, npm, NuGet, SourceForge, etc.

![NuGet](https://img.shields.io/nuget/dt/Microsoft.AspNetCore.Mvc.svg?style=flat-square)
![npm](https://img.shields.io/npm/dw/localeval.svg?style=flat-square)
![Github All Releases](https://img.shields.io/github/downloads/atom/atom/total.svg?style=flat-square)
![SourceForge](https://img.shields.io/sourceforge/dm/sevenzip.svg?style=flat-square)

Otras etiquetas

Además de las etiquetas para las Builds y las descargas, Shields nos ofrece otras muchas.

Tenemos la opción de añadir una etiqueta con el versionado de nuestros proyectos.

GitHub tag

También podemos añadir etiquetas de carácter social. Como los seguidores de Twitter o las estrellas en GitHub.

GitHub followers

Y otras muchas cosas más:

GitHub pull requests

Github file size

Docker Stars

Chrome Web Store

Podéis ver el listado completo en la página de shields.io.

Etiquetas personalizadas

Otra opción que tenemos es la de personalizar nuestras propias etiquetas siguiendo este patrón.


https://img.shields.io/badge/TAG-VALUE-COLOR.svg

[![No Country for Geeks](https://img.shields.io/badge/Colaborando%20en-No%20Country%20for%20Geeks-orange.svg)](http://www.nocountryforgeeks.com/author/gallardo)

No Country for Geeks

De esta forma podemos poner enlaces más vistosos.

En resumen...

Como veis, es una gran forma de darle un poco de vida a nuestros readme y posts.

Podemos añadir mucha información para proyectos colaborativos como el estado de la build, las pull requerst, la cobertura de código, etc. gracias a la gran cantidad de plataformas que soporta.

Creo que voy a empezar a añadir alguna de estas etiquetas en los proyectos en los que participe. Os animo a hacer lo mismo.

Un saludo y ¡nos vemos en el futuro!

Twitter URL