Skip to main content

ProconTEL File

The .procontel file is a configuration file used by the ProconTEL CLI tool. It is expected to exist in the current folder, or it can be provided using the "-f/--file" parameter with a relative or absolute path argument to the file. As a convention, this file follows the YAML format, providing a human-readable and structured way to represent data.

File example

version: '4.0.0'

apps:
  amazing-app:
    description: Description of my app
    runtime: dotnet
    version: 6
    arguments: -port=9090
    build:
      project: ./src/project-path
      output: ./custom-path/artifacts
      buildArguments: -c Debug
    tags:
      - Release 1.0
      - stable

The file contains the following elements:

  1. version: - The version of the CLI tool syntax targeted by the file.
  2. apps: - A list of applications, required and cannot be empty. This section contains configurations for different applications.
  3. amazing-app: - An alias for the application, which is required. It is a unique identifier for the specific application.
  4. description: - An optional description of the application. If not provided, the default alias is used.
  5. runtime: - An optional runtime type for the application. The default value is "dotnet".
  6. version: - An optional runtime version of the application. The default value is "6".
  7. arguments: - An optional custom arguments for the application.
  8. build: - An optional build configurations for the application.
    • project: - An optional relative path to .procontel file to the folder containing the application's project. The default is the current directory.
    • output: - An optional relative path to .procontel file to the directory where the build artifacts will be generated. The default is ".pct-artifacts" in the current directory.
    • buildArguments - An optional custom arguments for the build process. The arguments given in this parameter have the highest priority. If a path to output is specified in buildArguments, it will overwrite the value entered in the output field.
  9. tags: - An optional list of tags assigned to the app template revision created by the push command. Each tag is a separate list item. A tag cannot contain a comma and can have at most 30 characters; at most 10 tags are allowed. Tags provided with the --tag option of the push command replace the tags defined here.