Philip Withnall
philip.withnall@collabora.co.uk 2015

This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.

As a special exception, the copyright holders give you permission to copy, modify, and distribute the example code contained in this document under the terms of your choosing, without restriction.

Versionado y publicación de bibliotecas y aplicaciones
Daniel Mustieles
daniel.mustieles@gmail.com 2016-2020
Javier Mazorra
mazi.debian@gmail.com 2016, 2020

# Versionado

#

        Resumen

        La versión del módulo difiere para bibliotecas y aplicaciones: las bibliotecas necesitan una versión de libtool especificada además de su versión de paquete. Las aplicaciones solo tienen una versión de paquete.

          Las bibliotecas y aplicaciones tienen una versión de paquete de la forma major.minor.micro. ()
          Las bibliotecas además tienen una versión de libtool de la forma current:revision:age. ()
          Los números de versión deben actualizarse para cada versión (usando incrementos de versión y post-versión). ()
          Las versiones de paquete se deben incrementar  para cambios de características o adiciones. ()
          Las versiones de Libtool deben actualizarse para cambios o adiciones de API. ()
          Las versiones menores pares/impares de paquetes se pueden usar respectivamente para versiones estables/inestables. ()

# Versionado de paquetes

Tanto las bibliotecas como las aplicaciones tienen una versión de paquete de la forma major.minor.micro.

El número de versión del paquete es el que se pasa a `AC_INIT()`, y el que se suele conocer como número de versión del proyecto. Por ejemplo, el paquete Debian para una biblioteca utilizará la versión del paquete de la biblioteca (aunque también puede incluir el numero de versión principal en el nombre del paquete para permitir instabilidad en paralelo). Las versiones del paquete son actualizadas con las siguientes reglas:

Si en una biblioteca se rompe la compatibilidad API, o se hace un gran cambio a una aplicación que afecta a todo (como un rediseño de IU), incremente la versión principal, y establezca la menor y la micro a 0.

De lo contrario, si cambia o agrega una característica, o agrega cualquier API, incremente la menor y establezca la micro en 0.

En caso contrario (si se hace una publicación que contenga sólo correcciones de errores y actualizaciones de traducciones), se incrementa la microversión.

Tenga en cuenta que el número de versión menor debería actualizarse si se añade alguna API.

# Versionado de Libtool

Las bibliotecas tienen dos números de versión: una versión libtool que rastrea la compatibilidad ABI posterior (). y una versión de paquete que rastrea los cambios de las características. Estos normalmente se incrementan sincronizadamente, pero deberían mantenerse separados porque la compatibilidad ABI posterior no está necesariamente relacionada con los cambios de las características o las correcciones de errores. Además, los dos números de versión tienen distintos significados, y no puede generarse automáticamente el uno desde el otro.

Un buen resumen del versionado libtool, y las diferencias con el versionado del paquete, se da en el cazador de mitos de Autotools; otro está en el manual de libtool.

Para actualizar la versión libtool, siga el algoritmo dado en los comentarios debajo. Este es un fragmento de código configure.ac típico para configurar el versionado libtool:

# Before making a release, the LT_VERSION string should be modified. The # string is of the form c:r:a. Follow these instructions sequentially: # 1. If the library source code has changed at all since the last update, then # increment revision (‘c:r:a’ becomes ‘c:r+1:a’). # 2. If any interfaces have been added, removed, or changed since the last # update, increment current, and set revision to 0. # 3. If any interfaces have been added since the last public release, then # increment age. # 4. If any interfaces have been removed or changed since the last public # release, then set age to 0. AC_SUBST([LT_VERSION],[0:0:0])

El siguiente fragmento de código se puede usar en un Makefile.am para pasar esa información de versión a libtool:

my_library_la_LDFLAGS = -version-info $(LT_VERSION)

# Versiones de paquetes estables e inestables

La mayoría de los módulos de GNOME siguen una convención para publicaciones estables e inestables. La versión menor es par para liberaciones estables y es impar para las inestables. Por ejemplo, las versiones 3.20.* son estables, pero las versiones 3.19.* son inestables. Las versiones 3.19.* se pueden ver como entregas alfa y beta de la versión 3.20.

Una nueva microversión estable (por ejemplo 3.20.0 → 3.20.1) no añade nuevas características, sólo actualizaciones de traducciones y corrección de errores. Por otro lado, las micropublicaciones inestables (por ejemplo 3.19.1 → 3.19.2) pueden añadir API, o cambiar o eliminar la API que se añadió en la micropublicación anterior en esa serie menor.

La versión libtool debería actualizarse sólo para versiones de paquete estables.

# Proceso de publicación

El proceso estándar para hacer una publicación de un módulo incrementa la versión libtool (si el módulo es una biblioteca) en el momento de la entrega, por lo que incrementa el número de versión del paquete inmediatamente después (a esto se le llama un incremento posterior a la publicación).

La actualización de las versiones libtool durante el tiempo de publicación significa que sólo se incrementan una vez para todos los cambios ABI de una entrega. Usar el incremento posterior a la publicación para las versiones del paquete significa que el número de versión del paquete no está desactualizado (aún igual al de la entrega anterior) durante el ciclo de desarrollo.

El proceso de la publicación (basado en el proceso de publicación de GNOME):

Asegúrese de que el código está actualizado: git pull

Asegúrese de que no tiene cambios locales: git status

Si la publicación es para una versión estable del paquete, incremente el número de versión libtool en configure.ac (si éste existe)

Añada una entrada al archivo NEWS

Ejecute ./autogen.sh && make && make install && make distcheck y asegúrese de que termina correctamente

Corrija los errores que surjan, confirme esos cambios, y reincide en el paso 3

Si make distcheck finaliza con «El [archivo] está listo para su distribución», ejecute git commit -a -m «Versión de la publicación x.y.z»

Ejecute git push

Si eso no funciona debido a que otros commits se han subido mientras tanto, ejecute git pull para mezclar su commit en la rama seguida de un segundo git push. Esta es una excepción a la directriz de GNOME de tener un histórico de Git lineal (). Si usted prefiere tener un histórico lineal, es necesario reiniciar en el paso 1.

Etiquete la publicación: git tag -s x.y.z (donde ‘x.y.z’ es el número de versión del paquete)

Ejecute git push origin x.y.z (donde ‘x.y.z’ es el número de versión del paquete)

Ahora la publicación está completa, y se puede hacer el incremento de versión posterior a la misma:

Incremente el número de la versión del paquete en configure.ac

Ejecute git commit -a -m "Post-release version increment"

Ejecute git push

El archivo de paquete generado por make distcheck puede subirse ahora a download.gnome.org o distribuirse de otras maneras.