config.md

configuration

Tag Publish configuration file

Properties

• version (object): The version configurations.
  • branch_to_version_re: Refer to #/definitions/version_transform.
  • tag_to_version_re: Refer to #/definitions/version_transform.
• docker: Refer to #/definitions/publish_docker.
• pypi: Refer to #/definitions/publish_pypi.
• helm: Refer to #/definitions/publish_helm.
• dispatch (array): Default: [{}].
  • Items (object): Send a dispatch event to an other repository. Default: {}.
    • 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".

Definitions

• publish_docker (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 tag-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 tag-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 tag-publish script. Default: ["version_tag", "version_branch", "rebuild", "feature_branch"].
        • Items (string)
  • 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.
• publish_pypi (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 tag-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 tag-publish script. Default: ["version_tag"].
    • Items (string)
• 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 tag-publish script. Default: ["version_tag"].
        • Items (string)
    • : Must be: false.
• version_transform (array): A version transformer definition.
  • Items (object)
    • from (string): The from regular expression.
    • to (string): The expand regular expression: https://docs.python.org/3/library/re.html#re.Match.expand.