Skip to content

afq-checklist-manifest-instr.md

Latest commit

 

History

History
75 lines (70 loc) · 3.65 KB

afq-checklist-manifest-instr.md

File metadata and controls

75 lines (70 loc) · 3.65 KB
Raw

FreeRTOS manifest file instructions

A manifest file is required for AWS IoT Device Tester to identify versions and libraries being used. It helps customers delineate versions, libraries dependencies, and metadata.

The file should meet the following requirements:

  • The file must be named manifest.yml.
  • It must be in the base folder of the library or package.
  • It must be in YAML format and follow the YAML 1.2 specifications.

The parameters can be in any order, but we recommend that you put them in the order listed below for optimal readability. Add comments to the file to help customers use your package.

File path
Located at the root of a package or library. There is only one manifest file per package. Dependencies that are brought in may have their own manifest files.

Parameters
name
The name of the package. All spaces should be replaced with an underscore (_). For example, My project name - 2020 should be changed to My_project_name_-_2020.

  • type: string
  • required: true
  • minLength: 1
  • maxLength: 40
    version
    The version of the package. The version can be a release version or version tag.
  • type: string
  • required: true
  • minLength: 1
  • maxLength: 30
    description
    The human-readable description of the package. The description should clearly describe what the package is and what it provides.
  • type: string
  • required: true
  • minLength: 30
  • maxLength: 255
    dependencies
    A list of all first-level dependencies that are required for a user to successfully build this package and which can be retrieved by a Git, Subversion, or Mercurial source code host. Don't include dependencies that are not available through Git, SVG, or hg. Don't include dependencies used for tests, documentation generation, or development. To promote a good experience, we recommend you avoid listing dependencies that are gated or private.
  • type: array
  • required: false
  • minLength: 0
    dependencies[].name
    The package name of a dependency. This must match the package name found in the dependency's name parameter.
  • type: string
  • required: true
  • minLength: 1
  • maxLength: 40
    dependencies[].version
    The version of a dependency. The version can be a release version or a version tag. If any dependencies are included within the package itself, the version must match the manifest file that is in the dependency.
  • type: string
  • required: true
  • minLength: 1
  • maxLength: 30
    dependencies[].repository
    Describes the location of the dependency source code.
  • type: dictionary
  • required: true
    dependencies[].repository.type
    The type of repository.
  • type: string
  • required: true
  • enum: [git, svn, hg]
    dependencies[].repository.url
    The URL of the location of the repository. This must be a full URL with a protocol prefix (for example, https://github\.com/*ACCOUNT\_NAME*/*REPO\_NAME*\)\.
  • type: string
  • required: true
    dependencies[].repository.path
    The relative path from the project workspace for the dependency.
  • type: string
  • required: true
    dependencies[].repository.branch
    The branch of the dependency that is used. If the package uses the release branch of libraries, don't include this parameter to keep the length of the manifest at a minimum.
  • type: string
  • required: false
    license
    The SPDX license identifier of the library. For the full list, see https://spdx.org/licenses/. It should match the LICENSE file included in the root of the repository if it exists.
  • type: string
  • required: true