Instrucciones para el archivo de manifiesto de FreeRTOS - FreeRTOS

Instrucciones para el archivo de manifiesto de FreeRTOS

Se necesita un archivo de manifiesto para AWS IoT Device Tester para identificar las versiones y bibliotecas que se utilizan. Ayuda a los clientes a delinear las versiones, las dependencias de las bibliotecas y los metadatos.

El archivo debe cumplir con los siguientes requisitos:

  • El archivo debe denominarse manifest.yml.

  • Debe estar en la carpeta base de la biblioteca o el paquete.

  • Debe estar en formato YAML y seguir las especificaciones de YAML 1.2.

Los parámetros pueden estar en cualquier orden, pero le recomendamos que los coloque en el orden que se indica a continuación para una legibilidad óptima. Añada comentarios al archivo para ayudar a los clientes a usar su paquete.

Ruta de archivo

Se encuentra en la raíz de un paquete o biblioteca. Solo hay un archivo de manifiesto por paquete. Las dependencias que se incorporan pueden tener sus propios archivos de manifiesto.

Parámetros
nombre

El nombre del paquete. Todos los espacios deben reemplazarse por un guión bajo (_). Por ejemplo, My project name - 2020 debe cambiarse a My_project_name_-_2020.

  • type: string

  • required: true

  • minLength: 1

  • maxLength: 40

versión

Versión del paquete. La versión puede ser una versión de lanzamiento o una etiqueta de versión.

  • type: string

  • required: true

  • minLength: 1

  • maxLength: 30

description

La descripción en lenguaje natural del paquete. La descripción debe describir claramente qué es el paquete y qué proporciona.

  • type: string

  • required: true

  • minLength: 30

  • maxLength: 255

dependencias

Una lista de todas las dependencias de primer nivel que se requieren para que un usuario cree correctamente este paquete y que se pueden recuperar mediante un host de código fuente de Git, Subversion o Mercurial. No incluya dependencias que no estén disponibles en Git, SVG o hg. No incluya las dependencias que se utilizan para las pruebas, la generación de documentación o el desarrollo. Para promover una buena experiencia, le recomendamos que evite incluir en la lista las dependencias cerradas o privadas.

  • type: array

  • required: false

  • minLength: 0

dependencies[].name

El nombre del paquete de una dependencia. Debe coincidir con el nombre del paquete que se encuentra en el parámetro name de la dependencia.

  • type: string

  • required: true

  • minLength: 1

  • maxLength: 40

dependencies[].version

La versión de una dependencia. La versión puede ser una versión de lanzamiento o una etiqueta de versión. Si se incluye alguna dependencia en el propio paquete, la versión debe coincidir con el archivo de manifiesto que se encuentra en la dependencia.

  • type: string

  • required: true

  • minLength: 1

  • maxLength: 30

dependencies[].repository

Describe la ubicación del código fuente de la dependencia.

  • type: dictionary

  • required: true

dependencies[].repository.type

El tipo de repositorio.

  • type: string

  • required: true

  • enum: [git, svn, hg]

dependencies[].repository.url

La dirección URL de la ubicación del repositorio. Debe ser una URL completa con un prefijo de protocolo (por ejemplo, https://github.com/ACCOUNT_NAME/REPO_NAME).

  • type: string

  • required: true

dependencies[].repository.path

La ruta relativa desde el espacio de trabajo del proyecto para la dependencia.

  • type: string

  • required: true

dependencies[].repository.branch

La rama de la dependencia que se utiliza. Si el paquete usa la rama de publicación de las bibliotecas, no incluya este parámetro para reducir al mínimo la longitud del manifiesto.

  • type: string

  • required: false

license

El identificador de licencia SPDX de la biblioteca. Puede consultar la lista completa en https://spdx.org/licenses/. Debe coincidir con el archivo LICENSE incluido en la raíz del repositorio, si existe.

  • type: string

  • required: true