Conceptos de planos personalizados

Estos son algunos conceptos y términos que debe conocer al trabajar con planos personalizados. CodeCatalyst

Proyecto de anteproyecto

Un proyecto de anteproyecto te da la posibilidad de desarrollar y publicar planos para tu espacio. Durante el proceso de creación del proyecto, se crea un repositorio de origen y el nombre del repositorio es el que se elige al introducir los detalles de los recursos del proyecto. Durante el proceso de creación del blueprint, si decide generar una versión del flujo de trabajo, se crea un flujo de trabajo de publicación en su blueprint con el blueprint Builder. El flujo de trabajo publica automáticamente su última versión.

Planos de espacio

Puedes ver y gestionar todos los planos desde la tabla de planos de espacios cuando accedas a la sección Planos de tu espacio. Una vez publicados los planos en tu espacio, estarán disponibles como planos de espacio para añadirlos y eliminarlos del catálogo de planos de tu espacio. También puedes gestionar los permisos de publicación y eliminar los planos desde la sección Planos de tu espacio. Para obtener más información, consulte Visualización de los detalles, las versiones y los proyectos de un blueprint personalizado.

Catálogo de planos de espacios

Puedes ver todos los planos personalizados añadidos desde el catálogo de planos de un espacio. Aquí es donde un miembro del espacio puede elegir su plano personalizado para crear un nuevo proyecto. Este catálogo es diferente del CodeCatalyst catálogo, que ya tiene planos disponibles para todos los miembros del espacio. Para obtener más información, consulte Creación de un proyecto integral con CodeCatalyst planos.

Síntesis

La síntesis es el proceso de generar un paquete de CodeCatalyst proyectos que representa el código fuente, la configuración y los recursos de un proyecto. Luego, las operaciones de la API de CodeCatalyst despliegue utilizan el paquete para implementarlo en un proyecto. El proceso se puede ejecutar de forma local mientras se desarrolla un plan personalizado para emular la creación del proyecto sin tener que crear un proyecto en él. CodeCatalyst Se pueden usar los siguientes comandos para realizar la síntesis:

yarn blueprint:synth             # fast mode
yarn blueprint:synth --cache     # wizard emulation mode

El plano comienza por sí solo llamando a la blueprint.ts clase principal con esa opción fusionadadefaults.json. Se genera un nuevo paquete de proyectos en la synth/synth.[options-name]/proposed-bundle/ carpeta. El resultado incluye el paquete de proyectos que genera un esquema personalizado, según las opciones que haya establecido, incluidas las opciones parciales que haya configurado.

Resíntesis

La resíntesis es el proceso de regenerar un plano con diferentes opciones de planos o versiones de planos de proyectos existentes. Como autor de un esquema, puede definir estrategias de combinación personalizadas en el código del esquema personalizado. También puede definir los límites de propiedad .ownership-file para especificar en qué partes del código base se permite actualizar un esquema. Si bien el esquema personalizado puede proponer actualizaciones.ownership-file, los desarrolladores de proyectos que lo utilicen pueden determinar los límites de propiedad de sus proyectos. Puede ejecutar la resíntesis de forma local y probarla y actualizarla antes de publicar su esquema personalizado. Utilice los siguientes comandos para realizar la resíntesis:

yarn blueprint:resynth             # fast mode
yarn blueprint:resynth --cache     # wizard emulation mode

El plano comienza por sí solo llamando a la blueprint.ts clase principal con esa opción fusionada. defaults.json Se genera un nuevo paquete de proyectos en la synth/resynth.[options-name]/ carpeta. El resultado incluye el paquete de proyectos que genera un esquema personalizado, según las opciones que haya establecido, incluidas las opciones parciales que haya configurado.

Tras los procesos de síntesis y resíntesis, se crean los siguientes contenidos:

• paquete propuesto: el resultado de la síntesis cuando se ejecuta con nuevas opciones para la versión del plan objetivo.

• existing-bundle: un simulacro de tu proyecto actual. Si no hay nada en esta carpeta, se genera con el mismo resultado que él. proposed-bundle

• ancestor-bundle: un simulacro de lo que generaría tu blueprint si lo ejecutaras con una versión anterior, con opciones anteriores o con una combinación de ellas. Si no hay nada en esta carpeta, se genera con el mismo resultado que la. proposed-bundle

• resolved-bundle: el paquete siempre se regenera y, por defecto, se combina a tres bandas entre, y. proposed-bundle existing-bundle ancestor-bundle Este paquete proporciona una emulación de lo que generaría una resíntesis de forma local.

Para obtener más información sobre los paquetes de salida de blueprint, consulte. Generar archivos con resíntesis

Opciones parciales

Puede añadir variantes de opciones para no tener src/wizard-configuration/ que enumerar toda la Options interfaz y las opciones se combinan en la parte superior del defaults.json archivo. Esto te permite adaptar los casos de prueba a distintas opciones.

Ejemplo:

Optionsinterfaz:

{
  language: "Python" | "Java" | "Typescript",
  repositoryName: string
  ...
}

Archivo defaults.json:

{
  language: "Python",
  repositoryName: "Myrepo"
  ...
}

Pruebas de configuración adicionales:

• #wizard-config-typescript-test.json
  {
    language: "Typescript",
  }

• #wizard-config-java-test.json
  {
    language: "Java",
  }

Projen

Projen es una herramienta de código abierto que utilizan los planos personalizados para mantenerse actualizados y coherentes. Los blueprints vienen como paquetes de Projen porque este marco te permite crear, agrupar y publicar proyectos, y puedes usar la interfaz para gestionar las configuraciones y los ajustes de un proyecto.

Puedes usar Projen para actualizar los planos a escala, incluso después de haberlos creado. La herramienta Projen es la tecnología subyacente a la síntesis de planos que genera un paquete de proyectos. Projen es el propietario de la configuración de un proyecto y no debería afectarte a ti como autor de los planos. Puede ejecutar yarn projen para regenerar la configuración del proyecto después de añadir las dependencias, o bien puede cambiar las opciones del archivo. projenrc.ts Projen también es la herramienta de generación subyacente de planos personalizados para sintetizar un proyecto. Para obtener más información, consulte la página del proyecto. GitHub Para obtener más información sobre cómo trabajar con Projen, consulte la documentación de Projen y Cómo simplificar la configuración de un proyecto con Projen.