CAJA COSTARRICENSE DE SEGURO SOCIAL

Gerencia Infraestructura y Tecnologas Subgerencia Tecnologas de Informacin y Comunicaciones

rea de Soporte Tcnico

Procedimiento de Control de Versiones

TIC-GAC-0005

Versin 2.2.0 Julio 2008

Procedimiento de Control de Versiones

TIC-GAC-0005 Versin: 2.2.0

Historial de Revisin
Fecha 10/12/2004 Versin 1.0 Plan Inicial Descripcin Autor Grupo de Trabajo para definir la Metodologa de Desarrollo de Sistemas. Grupo de Trabajo para definir la Metodologa de Desarrollo de Sistemas. Grupo de Trabajo para definir la Metodologa de Desarrollo de Sistemas. Grupo de Trabajo CMMI

01/12/2006

2.0

Ajustes al documento para adaptarlo a la forma de trabajo de todas las reas que desarrollan sistemas en la direccin de Tecnologas de Informacin y Comunicaciones Revisin del documento para comenzar a usarlo como versin oficial en la metodologa de desarrollo de software Ajustes al documento producto del anlisis en el proceso de CMMI

15/03/2007

2.1

06/05/2007

2.2

Subgerencia de Tecnologas de Informacin y Comunicaciones

CCSS 2007

2 de 9

Procedimiento de Control de Versiones

TIC-GAC-0005 Versin: 2.2.0

Tabla de Contenidos
1. 2. Introduccin ........................................................................................................................................... 4 Polticas para el Control de Versiones .................................................................................................. 4 Herramientas para el Control de Versiones .................................................................................. 4 Nomenclatura para artefactos y lneas base ................................................................................. 4 o artefactos ............................................................................................................................. 4 o Lneas base ......................................................................................................................... 5 Prcticas para el Versionamiento. ................................................................................................. 5 o Repositorio y Fases del control de versiones ..................................................................... 5 o Criterios de etiquetado ........................................................................................................ 5 Implementacin del versionamiento con ClearCase ............................................................................. 6 Creacin del repositorio ................................................................................................................. 6 Creacin de fases .......................................................................................................................... 6 Asignacin de nmero de versin a los artefactos y creacin de lneas base .............................. 6 Registro histrico de modificaciones a los artefactos .................................................................... 7 Proceso para el Control de Versiones ................................................................................................... 7 Descripcin detallada..................................................................................................................... 8 o Paso 1: Incluir al Repositorio de Control de Versiones ....................................................... 8 o Paso 2: Probar..................................................................................................................... 8 o Paso 3: Corregir .................................................................................................................. 8 o Paso 4: Poner en Produccin.............................................................................................. 8 o Paso 5: Distribuir ................................................................................................................. 8 o Paso 6: Pasar a Mantenimiento .......................................................................................... 8 Asignacin de Responsabilidades......................................................................................................... 9

3.

4.

5.

Subgerencia de Tecnologas de Informacin y Comunicaciones

CCSS 2007

3 de 9

Procedimiento de Control de Versiones

TIC-GAC-0005 Versin: 2.2.0

Procedimiento de Control de Versiones

1. Introduccin El propsito de este documento es definir el Procedimiento de Control de Versiones para los Proyectos de Desarrollo de Software en la CCSS. Se definen las polticas para el control de versiones, la implementacin con ClearCase del versionamiento y el proceso para el control de versiones. 2. Polticas para el Control de Versiones Herramientas para el Control de Versiones Se utilizar IBM Rational ClearCase como herramienta de control de versiones. Se instalar la versin Server de ClearCase en una mquina servidor para que ah residan de forma centralizada los repositorios de control de versiones de los proyectos de desarrollo de software. Se instalar la versin Cliente de ClearCase en las mquinas de los miembros del equipo de desarrollo desde donde accedern al repositorio centralizado. o Nomenclatura para artefactos y lneas base artefactos La nomenclatura para el etiquetado de las versiones de los artefactos estar definida como sigue: un nmero de versin compuesto por tres nmeros separados por un punto: 1.0.0. En caso de versiones preliminares (BETAS) de artefactos que estn en fase de desarrollo o pruebas, se usar la misma nomenclatura agregando una B al final del nmero de versin como sigue: 1.0.0B El nmero de versin aumentar de derecha a izquierda segn los siguientes criterios: El tercer nmero hacia la derecha (1.0.0) aumentar cuando se sufra modificaciones de forma/apariencia o bien modificaciones de impacto menor en el funcionamiento o contenido, por ejemplo de formato de letras o colores para documentos o ya sea apariencia fsica, formato de salida o correccin de errores menores para piezas de software. El segundo nmero hacia la derecha (1.0.0) aumentar cuando al artefacto se le realicen modificaciones de mediano impacto en el funcionamiento o contenido actual. Cuando aumente este nmero, el nmero de ms a la derecha deber volver a cero. CCSS 2007

Subgerencia de Tecnologas de Informacin y Comunicaciones

4 de 9

Procedimiento de Control de Versiones

TIC-GAC-0005 Versin: 2.2.0

El primer nmero de izquierda a derecha (1.0.0) amentar cuando al artefacto se le agregue o elimine funcionalidad y en general cuando se le realicen modificaciones que sean de alto impacto. Cuando aumente este nmero los dos nmeros de ms a la derecha debern volver a cero. Quedar a criterio de cada lder de proyecto determinar el nivel de impacto de una modificacin a un artefacto, para efectos de asignar un nmero de versin. o Lneas base La nomenclatura para el etiquetado de las lneas base estar definida como sigue: un prefijo LB ms un valor alfanumrico de 4 caracteres (que representar el nombre del sistema segn el Catlogo Institucional de Aplicaciones), ms un nmero de versin de 3 dgitos, quedando como sigue: LB_XXXX_999. Cada vez que se crea una nueva lnea base se aumentar el nmero de versin de la lnea base. Por ejemplo la lnea base 1 del sistema SCBM se nombrara as: LB_SCBM_1. o Prcticas para el Versionamiento. Repositorio y Fases del control de versiones Una fase representa el estado de desarrollo en que se encuentra un artefacto en un determinado momento durante su ciclo de vida. La implementacin tcnica de las fases depender de la herramienta que se use para hacer el control de versiones, por ejemplo con ClearCase las fases se implementarn a travs de ramas (branches). Fase de Desarrollo: residirn los artefactos que estn siendo desarrollados o modificados. Los artefactos en esta fase sern accesibles para todos los miembros del equipo de desarrollo del proyecto. Fase de Pruebas: pasarn a esta fase los artefactos que estn listos para ser revisados. En esta fase los artefactos sern accesibles nicamente para el Administrador de Versiones del Sistema. Fase de Produccin: pasarn a esta fase los artefactos que hayan sido dados por buenos despus de pasar por el proceso de revisin, validacin y/o pruebas. En esta fase los artefactos sern accesibles nicamente para el Administrador de Versiones del Sistema y para el/los encargado(s) de poner los artefactos correspondientes en el ambiente de ejecucin en produccin. o Criterios de etiquetado Los artefactos se etiquetarn con un nmero de versin desde la fase de desarrollo, sin embargo en estas fases se les agregar una B al final del nmero. Una vez que los artefactos estn listos
Subgerencia de Tecnologas de Informacin y Comunicaciones

CCSS 2007

5 de 9

Procedimiento de Control de Versiones

TIC-GAC-0005 Versin: 2.2.0 produccin conservarn el nmero de versin

para ponerse a funcionar en el ambiente de

asignado desde la fase de desarrollo pero se eliminar la B al final del nmero. La decisin de creacin de lneas base depender de las necesidades del equipo de desarrollo del proyecto, como referencia se espera que con la liberacin de una nueva versin del proyecto se cree a su vez una nueva lnea base. 3. Implementacin del versionamiento con ClearCase Creacin del repositorio Para cada proyecto se crear un VOB (Version Object Base) de tipo Public en ClearCase. El acceso a cada VOB se controlar bloqueando el VOB para todos los usuarios menos para aquellos que formen parte del grupo de desarrollo del proyecto. Ver el manual de uso de ClearCase para conocer cmo se bloquea el acceso a los VOB. Creacin de fases Para crear las fases del proyecto (BRANCH) se deber crear en el VOB del proyecto una RAMA

por cada fase, as el proyecto tendr tres ramas=fases: desarrollo, pruebas,

produccion. El acceso a cada fase=rama se controlar bloqueando la rama para todos los usuarios menos para los usuarios que corresponda segn el rol que desempeen en el proyecto. Ver el manual de uso de ClearCase para conocer cmo se bloquean las ramas. Una vez creadas las ramas correspondientes, se configurar el cliente de ClearCase para que se conecte a las vistas dinmicas de desarrollo, pruebas o produccin, o bien habr que crear vistas estticas que permitan acceder a las ramas de desarrollo, pruebas o produccin segn tenga acceso cada usuario. Ver manual de uso de ClearCase para conocer como conectar ClearCase a vistas dinmicas y/o estticas. Asignacin de nmero de versin a los artefactos y creacin de lneas base La asignacin de nmero de versin y la creacin de lneas base se har mediante la aplicacin de ETIQUETAS (LABELS) de ClearCase. As, para asignar un nmero de versin o para asignar un nombre de lnea base a un conjunto de artefactos, se utilizar la funcionalidad de ClearCase para aplicar a cada uno de los artefactos una etiqueta con el nombre y formato de la versin o lnea base segn corresponda. Ver el manual de uso de ClearCase para conocer cmo aplicar etiquetas.

Subgerencia de Tecnologas de Informacin y Comunicaciones

CCSS 2007

6 de 9

Procedimiento de Control de Versiones

TIC-GAC-0005 Versin: 2.2.0

Registro histrico de modificaciones a los artefactos Los pasos para modificar un artefacto que haya sido agregado al repositorio de control de versiones son: desprotegerlo (check out), modificarlo, protegerlo (check in). Cada vez que se realiza este proceso, ClearCase guarda una copia del artefacto antes de ser modificado y luego genera una nueva copia con la modificacin asignndole a cada copia un nmero consecutivo. Este nmero corresponde a un nmero de versin automticamente asignado, sin embargo el nmero de versin para efectos del proceso de control de versiones ser el que se asigne por el equipo de desarrollo a travs de una etiqueta segn la nomenclatura ya descrita. Ver el manual de uso de ClearCase para conocer cmo hacer CHECK IN y CHECK OUT a los artefactos.

4. Proceso para el Control de Versiones

Proceso para el Control de Versiones Proceso para el Control de Versiones

Fase de Desarrollo
Paso 1) INCLUIR AL REPOSITORIO DE CONTROL DE VERSIONES (Cualquier rol, asignas nmero de versin + B)

Paso 2) PROBAR (Cualquier rol)

Paso 3) CORREGIR (Cualquier rol) Paso 6) PASAR A MANTENIMIENTO (Admor. de Proyecto)

Fase de Pruebas

Paso 4) PONER EN PRODUCCIN (Admor. deVersiones)

Fase de Produccin
Paso 5) DISTRIBUIR (Encargado de Distribucin)

Entorno de Ejecucin en Produccin

Subgerencia de Tecnologas de Informacin y Comunicaciones

CCSS 2007

7 de 9

Procedimiento de Control de Versiones

TIC-GAC-0005 Versin: 2.2.0

Descripcin detallada Paso 1: Incluir al Repositorio de Control de Versiones Se refiere a incluir artefactos por primera vez en el repositorio de Control de Versiones. Quedar a criterio del Administrador de Versiones/Proyecto determinar quienes podrn incluir artefactos en el repositorio de control de versiones. Los artefactos estarn en fase de desarrollo hasta alcanzar un estado susceptible de revisin o pruebas, esto es que el artefacto cumple con los requerimientos especificados. Una vez que el artefacto alcanza este estado pasar a fase de pruebas.

Paso 2: Probar Consiste en pasar un artefacto de la fase de desarrollo a la fase de pruebas. El artefacto pasar a la fase de pruebas una vez que se haya construido de forma que cumpla con los requerimientos especificados. Solo el Administrador de Versiones del proyecto podr pasar un artefacto a fase de pruebas.

Paso 3: Corregir Consiste en pasar a la fase de desarrollo un artefacto, para ser modificado o corregido, en caso que se encuentre algn problema durante el proceso de validacin en la fase de pruebas. Solo el Administrador de Versiones del proyecto podrn trasladar artefactos de la fase de pruebas a la fase de desarrollo.

Paso 4: Poner en Produccin Una vez validado, el artefacto ser traslado a la fase de produccin en caso de cumplir con las especificaciones solicitadas. Solo el Administrador de Versiones podr trasladar artefacto de la fase de pruebas a la de produccin. Para poder pasar artefactos a la fase de produccin, el encargado de comprobar la validez deber emitir un acta de aprobacin.

Paso 5: Distribuir Consiste en trasladar al Entorno de Ejecucin en Produccin aquellos artefactos en fase de produccin que as sean solicitados al Encargado de Distribucin. Esta tarea no corresponde al proceso de control de versiones pero se menciona por ser parte integral del ciclo de vida de cualquier artefacto del sistema.

Paso 6: Pasar a Mantenimiento De ser necesario modificar un artefacto que se encuentre en fase de produccin el repositorio de produccin, este deber trasladarse al repositorio de desarrollo, este traslado lo realizar el Administrador de Versiones a solicitud de algn miembro del equipo.

Subgerencia de Tecnologas de Informacin y Comunicaciones

CCSS 2007

8 de 9

Procedimiento de Control de Versiones

TIC-GAC-0005 Versin: 2.2.0

5. Asignacin de Responsabilidades Ac se debe definir quin dentro del equipo de desarrollo del proyecto ser responsable de ejecutar los siguientes roles: Administrador de Versiones Administrador del Proyecto Encargado de Distribucin

Subgerencia de Tecnologas de Informacin y Comunicaciones

CCSS 2007

9 de 9