config.md

Tag publish configuration

Tag Publish configuration file (.github/publish.yaml)

Properties

• transformers (object): The version transform configurations. Cannot contain additional properties. Default: {"pull_request_to_version": [{"to": "pr-\\1"}]}.
  • branch_to_version: Refer to #/definitions/transform.
  • tag_to_version: Refer to #/definitions/transform.
  • pull_request_to_version: Refer to #/definitions/transform.
• docker: Refer to #/definitions/docker.
• pypi: Refer to #/definitions/pypi.
• node: Refer to #/definitions/node.
• helm: Refer to #/definitions/helm.
• dispatch (array): Default: [].
  • Items (object): Send a dispatch event to an other repository. Cannot contain additional properties. 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: "published".

Definitions

• docker (object): The configuration used to publish on Docker. Cannot contain additional properties.
  • latest (boolean): Publish the latest version on tag latest. Default: true.
  • images (array): List of images to be published.
    • Items (object): Cannot contain additional properties.
      • 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": {"host": "ghcr.io", "versions_type": ["tag", "default_branch", "stabilization_branch", "rebuild"]}}.
    • Additional properties (object): Cannot contain additional properties.
      • host (string): The host of the repository URL.
      • versions_type (array): The kind or version that should be published, tag, branch or value of the --version argument of the tag-publish script. Default: ["tag", "default_branch", "stabilization_branch", "rebuild", "feature_branch", "pull_request"].
        • Items (string)
  • github_oidc_login (boolean): Auto login to the GitHub Docker registry. Default: true.
• pypi (object): Configuration to publish on pypi. Cannot contain additional properties.
  • packages (array): The configuration of packages that will be published.
    • Items (object): The configuration of package that will be published. Cannot contain additional properties.
      • group (string): The image is in the group, should be used with the --group option of tag-publish script. Default: "default".
      • folder (string): The folder of the pypi package. Default: ".".
      • build_command (array): The command used to do the build.
        • Items (string)
  • versions_type (array): The kind or version that should be published, tag, branch or value of the --version argument of the tag-publish script. Default: ["tag"].
    • Items (string)
• node (object): Configuration to publish on node. Cannot contain additional properties.
  • packages (array): The configuration of packages that will be published.
    • Items (object): The configuration of package that will be published. Cannot contain additional properties.
      • group (string): The image is in the group, should be used with the --group option of tag-publish script. Default: "default".
      • folder (string): The folder of the node package. Default: ".".
  • versions_type (array): The kind or version that should be published, tag, branch or value of the --version argument of the tag-publish script. Default: ["tag"].
    • Items (string)
  • repository (object): The packages repository where we should publish the packages. Can contain additional properties. Default: {"github": {"host": "npm.pkg.github.com"}}.
    • Additional properties (object): Cannot contain additional properties.
      • host (string): The host of the repository URL.
  • args (array): The arguments to pass to the publish command. Default: ["--provenance", "--access=public"].
    • Items (string)
• helm (object): Configuration to publish Helm charts on GitHub release. Cannot contain additional properties.
  • packages (array): The configuration of packages that will be published.
    • Items (object): The configuration of package that will be published. Cannot contain additional properties.
      • group (string): The image is in the group, should be used with the --group option of tag-publish script. Default: "default".
      • folder (string): The folder of the pypi package. Default: ".".
  • versions_type (array): The kind or version that should be published, tag, branch or value of the --version argument of the tag-publish script. Default: ["tag"].
    • Items (string)
• transform (array): A version transformer definition. Default: [].
  • Items (object): Cannot contain additional properties.
    • from_re (string): The from regular expression. Default: "(.+)".
    • to (string): The expand regular expression: https://docs.python.org/3/library/re.html#re.Match.expand. Default: "\\1".