Skip to content

Latest commit

 

History

History
101 lines (96 loc) · 7.44 KB

config.md

File metadata and controls

101 lines (96 loc) · 7.44 KB
Raw

configuration

C2C CI utils configuration file

Properties

  • print_versions: Refer to #/definitions/print_versions.
  • publish (object): The publishing configurations. Default: {"pypi": {"versions": ["version_tag"], "packages": "<auto-detected>"}, "docker": {"images": "<auto-detected>"}, "helm": {"versions": ["version_tag"], "folders": "<auto-detected>"}}.
  • version (object): The version configurations.
  • k8s (object): Default: {}.
    • k3d (object): Default: {}.
      • install-commands (array): Default: [["k3d", "cluster", "create", "test-cluster", "--no-lb", "--no-rollback"]].
        • Items (array)
          • Items (string)
    • db (object): Database configuration. Default: {}.
      • chart-options (object): Can contain additional properties. Default: {"persistence.enabled": "false", "tls.enabled": "true", "tls.autoGenerated": "true", "auth.postgresPassword": "mySuperTestingPassword", "volumePermissions.enabled": "true"}.
        • Additional properties (string)
  • dpkg (object): The configuration use t manage the dpkg packages. Cannot contain additional properties.
    • packages_mapping (object): The mapping of source package found in the image to package present in repology.org. Can contain additional properties.
      • Additional properties (string)
    • ignored_packages (array): The list of packages that should be ignored.
      • Items (string)

Definitions

  • publish_docker: The configuration used to publish on Docker.
    • One of
      • object: The configuration used to publish on Docker.
        • latest (boolean): Publish the latest version on tag latest. Default: true.
        • images (array): List of images to be published.
          • Items (object)
            • group (string): The image is in the group, should be used with the --group option of c2cciutils-publish script. Default: "default".
            • name (string): The image name.
            • tags (array): The tag name, will be formatted with the version=, the image with version=latest should be present when we call the c2cciutils-publish script. Default: ["{version}"].
              • Items (string)
        • repository (object): The repository where we should publish the images. Can contain additional properties. Default: {"github": {"server": "ghcr.io", "versions": ["version_tag", "version_branch", "rebuild"]}, "dockerhub": {}}.
          • Additional properties (object)
            • server (string): The server URL.
            • versions (array): The kind or version that should be published, tag, branch or value of the --version argument of the c2cciutils-publish script. Default: ["version_tag", "version_branch", "rebuild", "feature_branch"].
              • Items (string)
        • dispatch: Send a dispatch event to an other repository. Default: {}.
          • One of
            • object: Send a dispatch event to an other repository.
              • repository (string): The repository name to be triggered. Default: "camptocamp/argocd-gs-gmf-apps".
              • event-type (string): The event type to be triggered. Default: "image-update".
            • : Must be: false.
        • snyk (object): Checks the published images with Snyk.
          • monitor_args: The arguments to pass to the Snyk container monitor command. Default: ["--app-vulns"].
            • One of
              • array
                • Items (string)
              • : Must be: false.
          • test_args: The arguments to pass to the Snyk container test command. Default: ["--app-vulns", "--severity-threshold=critical"].
            • One of
              • array
                • Items (string)
              • : Must be: false.
      • : Must be: false.
  • publish_google_calendar: The configuration to publish on Google Calendar. Default: {}.
    • One of
      • object: The configuration to publish on Google Calendar.
        • on (array): Default: ["version_branch", "version_tag", "rebuild"].
          • Items (string)
      • : Must be: false.
  • publish_pypi: Configuration to publish on pypi. Default: {}.
    • One of
      • object: Configuration to publish on pypi.
        • packages (array): The configuration of packages that will be published.
          • Items (object): The configuration of package that will be published.
            • group (string): The image is in the group, should be used with the --group option of c2cciutils-publish script. Default: "default".
            • path (string): The path of the pypi package.
            • build_command (array): The command used to do the build.
              • Items (string)
        • versions (array): The kind or version that should be published, tag, branch or value of the --version argument of the c2cciutils-publish script.
          • Items (string)
      • : Must be: false.
  • publish_helm: Configuration to publish Helm charts on GitHub release.
    • One of
      • object: Configuration to publish on Helm charts on GitHub release.
        • folders (array): The folders that will be published.
          • Items (string)
        • versions (array): The kind or version that should be published, tag, branch or value of the --version argument of the c2cciutils-publish script.
          • Items (string)
      • : Must be: false.
  • print_versions (object): The print versions configuration.
    • versions (array): Default: [{"name": "python", "cmd": ["python3", "--version"]}, {"name": "pip", "cmd": ["python3", "-m", "pip", "--version"]}, {"name": "node", "prefix": "node ", "cmd": ["node", "--version"]}, {"name": "npm", "prefix": "npm ", "cmd": ["npm", "--version"]}, {"name": "make", "cmd": ["make", "--version"]}, {"name": "docker", "cmd": ["docker", "--version"]}, {"name": "docker compose", "cmd": ["docker", "compose", "version"]}, {"name": "java", "cmd": ["java", "-version"]}, {"name": "helm", "cmd": ["helm", "version"], "prefix": "HELM: "}].
      • Items (object)
        • cmd (array): The command that should be used.
          • Items (string)
        • name (string): The name.
        • prefix (string): Prefix added when we print the version.
  • version_transform (array): A version transformer definition.