Introducción a los esquemas personalizados
Durante el proceso de creación de un esquema, puede configurarlo y generar una vista previa de los recursos del proyecto. Todos los esquemas personalizados están administrados por un proyecto de CodeCatalyst que, de forma predeterminada, contiene un flujo de trabajo para la publicación en el catálogo de esquemas del espacio.
Al configurar los detalles de un esquema personalizado, también puede optar por almacenar el código fuente del esquema en un repositorio externo, donde podrá seguir administrando el esquema personalizado y utilizar las capacidades de administración del ciclo de vida para mantener los proyectos del espacio sincronizados cuando se modifique el esquema personalizado. Para obtener más información, consulte Adición de funcionalidad a proyectos mediante extensiones en CodeCatalyst y El trabajo del autor de esquemas con la administración del ciclo de vida.
Si ya dispone de un repositorio de código fuente con normas estandarizadas y prácticas recomendadas, puede optar por convertir ese repositorio de código fuente en un esquema personalizado. Para obtener más información, consulte Conversión de los repositorios de código fuente en esquemas personalizados.
Temas
Requisitos previos
Antes de crear un esquema personalizado, tenga en cuenta los siguientes requisitos:
El espacio de CodeCatalyst debe tener el nivel Enterprise. Para obtener más información, consulte Managing billing en la Guía del administrador de Amazon CodeCatalyst.
Para crear esquemas personalizados, debe tener el rol de administrador del espacio o usuario avanzado. Para obtener más información, consulte Concesión de acceso en los roles de usuario.
Paso 1: crear un esquema personalizado en CodeCatalyst
Cuando crea un esquema personalizado a partir de la configuración del espacio, se crea un repositorio automáticamente. El repositorio incluye todos los recursos necesarios que debe tener para desarrollar el esquema antes de publicarlo en el catálogo de esquemas del espacio.
Creación de un esquema personalizado
Abra la consola de CodeCatalyst en https://codecatalyst.aws/
. En la consola de CodeCatalyst, vaya al espacio donde desee crear un esquema personalizado.
En el panel de control del espacio, elija la pestaña Configuración y, a continuación, elija Esquemas.
Seleccione Crear esquema.
En Asignar nombre al esquema, introduzca el nombre que desea asignar al proyecto y los nombres de los recursos asociados. El nombre debe ser único dentro de su espacio.
-
(Opcional) De forma predeterminada, el código fuente creado por el esquema se almacena en un repositorio de CodeCatalyst. También puede elegir almacenar el código fuente del esquema en un repositorio de terceros. Para obtener más información, consulte Adición de funcionalidad a proyectos mediante extensiones en CodeCatalyst.
Realice una de las siguientes acciones en función del proveedor de repositorios de terceros que desee utilizar:
-
Repositorios de GitHub: conéctese a una cuenta de GitHub.
Seleccione el menú desplegable Avanzado, elija GitHub como proveedor del repositorio y, a continuación, elija la cuenta de GitHub en la que desee almacenar el código fuente creado por el esquema.
nota
Si utiliza una conexión a una cuenta de GitHub, debe crear una conexión personal para establecer una correspondencia de identidades entre su identidad de CodeCatalyst y la de GitHub. Para obtener más información, consulte Conexiones personales y Acceso a los recursos de GitHub con conexiones personales.
-
Repositorios de Bitbucket: conéctese a un espacio de trabajo de Bitbucket.
Seleccione el menú desplegable Avanzado, elija Bitbucket como proveedor del repositorio y, a continuación, elija el espacio de trabajo de Bitbucket en el que desee almacenar el código fuente creado por el esquema.
-
Repositorios de GitLab: conéctese a un usuario de GitLab.
Seleccione el menú desplegable Avanzado, elija GitLab como proveedor del repositorio y, a continuación, elija el usuario de GitLab en el que desee almacenar el código fuente creado por el esquema.
-
-
En Detalles del esquema, haga lo siguiente:
En el campo de entrada de texto Nombre de visualización del esquema, introduzca el nombre que aparecerá en el catálogo de esquemas del espacio.
En el campo de introducción de texto Descripción, escriba una descripción del esquema personalizado.
En el campo de entrada de texto Nombre del autor, introduzca un nombre de autor para el esquema personalizado.
-
(Opcional) Seleccione Configuración avanzada.
Seleccione + Añadir para añadir las etiquetas que se añadirán al archivo
package.json.Seleccione el menú desplegable Licencia y, a continuación, elija una licencia para el esquema personalizado.
En el campo de entrada de texto Nombre del paquete del esquema, introduzca un nombre para identificar al paquete del esquema.
De forma predeterminada, el flujo de trabajo de publicación se genera mediante un esquema de publicación dentro del proyecto, denominado Blueprint Builder. El flujo de trabajo publica la última versión del esquema en el espacio cuando envía los cambios, ya que el flujo de trabajo de publicación habilita los permisos de publicación. Para desactivar la generación del flujo de trabajo, desmarque la casilla Publicar flujo de trabajo.
(Opcional) Un proyecto de esquema viene con código predefinido para facilitar la publicación del esquema en el catálogo de esquemas del espacio. Para ver los archivos de definición con actualizaciones basadas en las selecciones de parámetros del proyecto que haya realizado, seleccione Ver código o Ver flujo de trabajo en Generar vista previa de esquema.
Seleccione Crear esquema.
Si no ha desactivado la generación del flujo de trabajo para el esquema personalizado, el flujo de trabajo comenzará a ejecutarse automáticamente cuando se cree el esquema. Cuando se complete la ejecución del flujo de trabajo, el esquema personalizado estará disponible, de forma predeterminada, para la adición en el catálogo de esquemas del espacio. Puede desactivar los permisos de publicación si no quiere que la última versión del esquema se publique automáticamente en el espacio. Para obtener más información, consulte Configuración de permisos de publicación para un esquema personalizado y Ejecución de un flujo de trabajo.
Como el flujo de trabajo de publicación denominado blueprint-release se crea mediante un esquema, este se puede encontrar como un esquema aplicado en el proyecto. Para obtener más información, consulte Incorporación de un esquema a un proyecto para integrar recursos y Desasociación de un esquema en un proyecto para detener las actualizaciones.
Paso 2: desarrollar un esquema personalizado con componentes
Al crear un esquema personalizado, se genera un asistente de esquemas, que se puede modificar con componentes al desarrollar el esquema personalizado. Puede actualizar los archivos src/blueprints.js y src/defaults.json para modificar el asistente.
importante
Si desea utilizar paquetes de esquemas de código fuente externo, tenga en cuenta los riesgos que podrían conllevar dichos paquetes. Los esquemas personalizados que añada en su espacio, así como el código que generen, quedan bajo su responsabilidad.
Cree un entorno de desarrollo en el proyecto de CodeCatalyst con un entorno de desarrollo integrado (IDE) compatible antes de configurar el código del esquema. Se necesita un entorno de desarrollo para trabajar con las herramientas y los paquetes necesarios.
Creación de un entorno de desarrollo
-
En el panel de navegación, lleve a cabo alguna de las siguientes acciones:
Seleccione Descripción general y vaya a la sección Mis entornos de desarrollo.
Seleccione Código y Entornos de desarrollo.
Seleccione Código y Repositorios de origen y elija el repositorio que creó al crear el esquema.
Seleccione Crear entorno de desarrollo.
Seleccione un IDE compatible desde el menú desplegable. Consulte Supported integrated development environments for Dev Environments para obtener más información.
Seleccione Trabajar en una ramificación existente y, en el menú desplegable Ramificación existente, seleccione la ramificación de características que ha creado.
(Opcional) En el campo de entrada de texto Alias: opcional, introduzca un alias para identificar el entorno de desarrollo.
Seleccione Crear. Mientras se crea el entorno de desarrollo, la columna de estado del entorno de desarrollo mostrará Iniciándose, y la columna de estado mostrará En ejecución una vez se haya creado el entorno de desarrollo.
Para obtener más información, consulte Creación y modificación de código con entornos de desarrollo en CodeCatalyst.
Desarrollo del esquema personalizado
-
En un terminal que funcione, utilice el siguiente comando de
yarnpara instalar las dependencias:yarnLas herramientas y los paquetes necesarios están disponibles a través del entorno de desarrollo de CodeCatalyst, lo que incluye Yarn. Si está trabajando en un esquema personalizado sin un entorno de desarrollo, instale primero Yarn en el sistema. Para obtener más información, consulte la documentación de instalación de Yarn
. -
Desarrolle el esquema personalizado de modo que esté configurado de acuerdo con sus preferencias. Puede modificar el asistente de esquemas añadiendo componentes. Para obtener más información, consulte Desarrollo de un esquema personalizado para cumplir los requisitos del proyecto, Modificación de las características del esquema con un asistente de front-end y Publicación de un esquema personalizado en un espacio.
Paso 3: obtener una vista previa de un esquema personalizado
Tras configurar y desarrollar un esquema personalizado, puede previsualizar y publicar la versión preliminar de este en su espacio. Una versión preliminar le permite comprobar si el esquema se corresponde con lo que necesita antes de usarlo para crear nuevos proyectos o antes de aplicarlo a proyectos existentes.
Vista previa de un esquema personalizado
-
En un terminal que funcione, use el siguiente comando de
yarn:yarn blueprint:preview -
Vaya al enlace
See this blueprint at:proporcionado para obtener una vista previa del esquema personalizado. Compruebe que la interfaz de usuario, lo que incluye el texto, aparezca como esperaba según su configuración. Si desea cambiar el esquema personalizado, puede editar el archivo
blueprint.ts, volver a sintetizar el esquema y publicar de nuevo una versión preliminar. Para obtener más información, consulte Resíntesis.
(Opcional) Paso 4: publicar una versión preliminar de un esquema personalizado
Puede publicar una versión preliminar del esquema personalizado en su espacio si desea añadirlo al catálogo de esquemas del espacio. Esto le permitirá ver el esquema como usuario antes de añadir la versión no preliminar al catálogo. La versión preliminar le permite publicar sin tener que utilizar una versión real. Por ejemplo, si trabaja en una versión 0.0.1, puede publicar y añadir una versión preliminar, de forma que las nuevas actualizaciones de una segunda versión puedan publicarse y añadirse como 0.0.2.
Publicación de la versión preliminar de un esquema personalizado
Vaya al enlace Enable version proporcionado para habilitar el esquema personalizado. Este enlace se proporciona al ejecutar el comando de [version number] at:yarn en el Paso 3: obtener una vista previa de un esquema personalizado.
Tras crear, desarrollar, previsualizar y publicar el esquema personalizado, podrá publicar la versión final de este y añadirla al catálogo de esquemas del espacio. Para obtener más información, consulte Publicación de un esquema personalizado en un espacio y Incorporación de un esquema personalizado a un catálogo de esquemas del espacio.
