Cómo trabajar con el CVS de Sourceforge y no morir en el intento
Para estar coordinados en el desarrollo de
cualquier proyecto, es absolutamente necesario estar habituados a manejar sistemas de control de versiones, como lo son el CVS.
El propósito del tutorial no es explicar lo que es un sistema de control de versiones, eso lo podéis ver
aquí. Lo que voy a explicar aquí es cómo utilizar dicho sistema de manera sencilla y adaptados a las peculiaridades que Sourceforge nos exige. El tutorial está orientado a usuarios de Windows, imagino que los usuarios de plataformas *nix sabrán adaptar los pasos descritos a sus sistemas.
Este tutorial asume que tenéis una cuenta de Sourceforge creada y en funcionamiento.
Así pues, ¡comencemos!
1 -. Descarga e instalación del software necesario
Lo primero es obtener el software que nos va a permitir trabajar con un repositorio CVS. Necesitaremos los siguientes programas:
- Suite PuTTY. Estupendo cliente SSH para Win32. La descarga es un archivo ZIP con los ejecutables de los programas. Es recomendable que lo descomprimáis en algún directorio que esté en el PATH de vuestro sistema, para después tener comodidad a la hora de ejecutar sus programas.
- Tortoise CVS. Cliente gráfico CVS para Win32. Es ultra-sencillo de utilizar, ya que se integra en el explorador de Windows mediante menús contextuales. Dispone de traducción al español que se puede activar en las preferencias, una vez instalado el programa.
Una vez instalados ambos programas podemos proceder al siguiente paso.
2 -. Generación de una clave SSH para trabajar con SourceforgeEn Sourceforge son muy precavidos con la seguridad de sus servidores, por lo que no aceptan el típico sistema de contraseña para iniciar sesión en ellos. Sourceforge sólo aceptara claves SSH2 DSA para los accesos. Así que tendremos que generarnos una para poder acceder.
Para ello lo primero es abrir el programa
PuTTYgen. Si colocásteis los archivos de PuTTY en el PATH bastará con que uséis el ejecutar del menú de inicio o bien una ventana de comandos del sistema (cmd.exe).
Para generar nuestra clave primero deberemos seleccionar
SSH2 DSA en los parámetros. Después podemos pulsar el botón
Generate tal como aparece en la captura de pantalla. El programa nos pedirá que movamos el raton en el cuadro de texto vacío para generar información aleatoria que será usada para formar la clave.
Una vez hecho esto la ventana del PuTTYgen os quedará más o menos de la siguiente manera:
Debéis rellenar los campos
KeyComment,
Passphrase y
Confirm Passphrase tal como aparecen en la captura:
- KeyComment: Vuestro nombre de usuario de Sourceforge seguido de @shell.sourceforge.net
- Passphrase: Contraseña con la que quereís proteger vuestra clave privada.
- Confirm Passphrase: Confirmar la contraseña.
Después de esto pulsáis
Save private key y guardáis vuestra clave privada en un sitio seguro de vuestro disco duro.
No cerréis aun el programa, lo seguimos necesitando tal y como está :)
¡Felicidades! Habéis generado vuestra clave SSH2 DSA.
3 -. Informar a Sourceforge de nuestra clave privada
Ya tenemos nuestra clave generada, pero Sourceforge no tiene esa clave asociada a nosotros, así que tenemos que decírsela para que nos reconozca cada vez que queramos acceder a sus servidores.
Para ello iniciad sesión en vuestra cuenta de Sourceforge e id a la
página de mantenimiento de vuestra cuenta. Casi al final de dicha página os encontraréis con lo siguiente:
Hay que hacer click en el enlace marcado en el recuadro rojo de la captura de pantalla. Esto nos llevará a una página nueva donde habrá que copiar y pegar la clave pública que todavía podemos ver en el programa PuTTYgen:
Copiad
todo el contenido del PublicKey en el cuadro de texto de la página de Sourceforge y
verificad que sólo ocupa una línea (aunque sea muy larga). Hecho esto pulsad
Update.
Con esto vuestra clave queda añadida a vuestra cuenta para que Sourceforge os reconozca. Pero cuidado, cuando se añade una nueva clave, el proceso de actualización no es inmediato, pueden pasar desde 5 minutos hasta 2 horas para que la asociación que acabáis de establecer se haga efectiva.
¡Hecho Sourceforge ya nos reconoce a través de nuestra clave SSH!
4 -. Preparar el Pageant para que nos autentique
Lo siguiente que debemos hacer es preparar el programa
Pageant para que use la clave que generamos en el paso 2.
Pageant es un programa que
deberá estar residente cada vez que vayamos a trabajar con los servidores de Sourceforge, ya que es el que se encarga de las autenticaciones a través de clave SSH.
Al cargar el programa veremos como se posiciona silenciosamente en la barra de iconos de al lado del reloj. Deberemos presionar con el boton derecho en dicho icono y nos aparecerá el siguiente menú:
Primero haremos click en
Add Key, tras lo cual nos aparecerá un cuadro de diálogo para seleccionar el archivo que contiene nuestra clave primaria. Seleccionamos el archivo que generamos en el paso 2 y lo añadimos. Si pusísteis una Passphrase en el archivo, os pedirá que la introduzcáis.
¡Este paso es necesario hacerlo siempre que carguemos el programa para trabajar con el CVS o la Shell de Sourceforge!
Una vez hecho esto volvemos a hacer click con el botón derecho en el icono del Pageant.
Esta vez seleccionamos
New Sessión, y nos aparecerá la siguiente ventana:
Rellenar los datos tal y como aparecen en la captura de pantalla y
salvarlos. Ahora podéis abrir la sesión creada para comprobar que habéis hecho todo bien hasta ahora. El servidor os pedirá
login, por lo que tenéis que introducir vuestro nombre de usuario de Sourceforge. Acto seguido, vuestra clave SSH tiene que actuar automáticamente y la sesión en la Shell de Sourceforge quedará iniciada, mostrando algo como:
Si habéis iniciado sesión en el servidor, no hay duda de que habéis hecho todo correctamente :) No hay mucho que hacer en esa Shell de momento, así que podéis cerrarla con exit.
¡Felicidades! ¡Habéis configurado con éxito el acceso CVS-SSH a los servidores de Sourceforge!
5 -. Trabajar con la CVS
Bajar un modulo de repositorio por primera vez (cvs co <modulo>)
Despues de toda la historia de claves, autenticaciones y otras hierbas, finalmente estamos listos para trabajar con el sistema CVS. Os sorprendera lo sencillo y útil que es.
¡No olvidéis tener el Pageant ejecutándose y con vuestra clave insertada cada vez que vayáis a usar el CVS!Lo primero es seleccionar la carpeta de vuestro disco duro donde van a estar los archivos con los que váis a trabajar. Seleccionar esta carpeta con el botón derecho y en el menú contextual veréis algo como
CVS Obtener... o
CVS Checkout...
Hacemos click en la opción marcada y nos aparecerá una ventana del Tortoise CVS para introducir los datos necesarios:
Deberemos rellenar sólo las áreas marcadas en rojo con los mismos datos que aparecen en la captura de pantalla, salvo el nombre de usuario claro :P
Hecho esto veréis una ventana de estado donde veréis el progreso de descarga de los distintos archivos. Después de esto podéis echar un vistazo al directorio y ver todos los archivos. Es importante no cambiar la estructura de dicho directorio, es decir, dejar los archivos en los mismos directorios en los que se encuentran.
Actualizar los archivos (cvs update)
Esta es la primera acción a realizar antes de que iniciemos una sesión de trabajo en nuestro proyecto. La operación
update actualiza los archivos a la última versión que se encuentre en el repositorio. De esta manera, se minimiza la posibilidad de que dos desarrolladores hagan trabajo por duplicado. Así que memorizad la regla de oro:
Siempre siempre siempre que vayais a empezar a trabajar, haced un update antes.
Los updates se hacen fácilmente haciendo click con el botón derecho en la carpeta en la que el primer día hicísteis el checkout:
La acción será inmediata y tras esto estaréis listos para trabajar sobre los archivos.
Confirmar los archivos (cvs ci)
Una vez hemos terminado nuestra sesión de trabajo, es necesario subir nuestros archivos para que las modificaciones estén disponibles cuando los demas desarrolladores del grupo hagan un update de sus fuentes. Esta operación se conoce como
commit o
checkin.
Para ello nos vamos a la carpeta del proyecto, hacemos click con el botón derecho en ella y seleccionamos
CVS Confirmar ó
CVS Commit.
Al hacer un commit se nos pedirá que introduzcamos un comentario sobe las modificaciones que hemos hecho. Es importante usar adecuadamente los comentarios para que los demás desarrolladores puedan entender las modificaciones que se han hecho en el proyecto. Además, dichos comentarios también sirven para hacer un seguimiento histórico de la evolución del proyecto.
¿Qué ocurre si se da un conflicto? (dos usuarios hacen commit del mismo código)
El CVS y una buena organización de proyecto minimizan las posibilidades de que esto ocurra, sin embargo siempre existe la posibilidad de que nos encontremos ante tan desafortunada ocurrencia.
Si el sistema encuentra conflicto entre dos o más desarrolladores que han modificado exactamente la misma parte del código, este marcará las diferencias existentes entre cada modificación y pedirá intervención del usuario para que edite el archivo y haga lo conveniente con cada una.
Por ahora esto es todo cuanto necesitámos saber para empezar a trabajar en proyectos de desarrollo en equipo. El sistema CVS tiene más funcionalidades de las descritas, pero me he limitado a hablar de las mínimas básicas que necesitamos para trabajar.
Espero que este tutorial os sea de utilidad a todos y podamos empezar a trabajar inmediatamente, que a fin de cuentas de esto se trata el club :)
Podéis dejar en el foro vuestras preguntas y comentarios sobre el tutorial.