config.md

configuration

C2C CI utils configuration file

Properties

• print_versions: Refer to #/definitions/print_versions.
• codespell: Refer to #/definitions/codespell.
• audit (object): The audit configuration. Default: {"snyk": true, "outdated_versions": true}.
  • outdated_versions: Refer to #/definitions/audit_outdated_versions.
  • snyk: Refer to #/definitions/audit_snyk.
• pr-checks (object): The PR check configuration. Default: {"commits_messages": true, "commits_spell": true, "pull_request_spell": true, "pull_request_labels": true, "add_issue_link": true}.
  • commits_messages: Refer to #/definitions/pr_checks_commits_messages.
  • commits_spell: Refer to #/definitions/pr_checks_commits_spell.
  • pull_request_spell: Refer to #/definitions/pr_checks_pull_request_spell.
  • pull_request_labels: Refer to #/definitions/pr_checks_pull_request_labels.
  • add_issue_link: Refer to #/definitions/pr_checks_add_issue_link.
• publish (object): The publishing configurations. Default: {"pypi": {"versions": ["version_tag"], "packages": "<auto-detected>"}, "docker": {"images": "<auto-detected>"}, "helm": {"versions": ["version_tag"], "folders": "<auto-detected>"}}.
  • docker: Refer to #/definitions/publish_docker.
  • pypi: Refer to #/definitions/publish_pypi.
  • helm: Refer to #/definitions/publish_helm.
  • google_calendar: Refer to #/definitions/publish_google_calendar.
• version (object): The version configurations.
  • branch_to_version_re: Refer to #/definitions/version_transform.
  • tag_to_version_re: Refer to #/definitions/version_transform.
• 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)

Definitions

• audit_outdated_versions (boolean): Audit of outdated version.
• audit_snyk: The audit snyk configuration.
  • One of
    • object: The audit Pipfile configuration.
      • test_arguments (array): The snyk test arguments. Default: ["--all-projects", "--fail-on=all", "--severity-threshold=medium"].
        • Items (string)
      • monitor_arguments (array): The snyk monitor arguments. Default: ["--all-projects"].
        • Items (string)
      • fix_arguments (array): The snyk fix arguments. Default: ["--all-projects"].
        • Items (string)
      • fix_github_create_pull_request_arguments (array): The snyk fix pull request extra arguments. Default: ["--fill", "--label=dependencies"].
        • Items (string)
      • pip_install_arguments (array): The snyk pip install arguments. Default: ["--user"].
        • Items (string)
      • pipenv_sync_arguments (array): The snyk pipenv sync arguments. Default: [].
        • Items (string)
      • files_no_install (array): The list of files to not install. Default: [].
        • Items (string)
    • boolean
• codespell (object): The codespell check configuration.
  • internal_dictionaries (array): List of argument that will be added to the codespell command. Default: ["clear", "rare", "informal", "code", "names", "en-GB_to_en-US"].
    • Items (string)
  • arguments (array): List of argument that will be added to the codespell command. Default: ["--quiet-level=2", "--check-filenames", "--ignore-words-list=ro"].
    • Items (string)
  • ignore_re (array): List of regular expression that should be ignored. Default: ["(.*/)?poetry\\.lock", "(.*/)?package-lock\\.json"].
    • Items (string)
• pr_checks_commits_messages: Check the pull request commits messages.
  • One of
    • object: The commit message check configuration.
      • check_fixup (boolean): Check that we don't have one fixup commit in the pull request. Default: true.
      • check_squash (boolean): Check that we don't have one squash commit in the pull request. Default: true.
      • check_first_capital (boolean): Check that the all the commits message starts with a capital letter. Default: true.
      • min_head_length (integer): Check that the commits message head is at least this long, use 0 to disable. Default: 5.
      • check_no_merge_commits (boolean): Check that we don't have merge commits in the pull request. Default: true.
      • check_no_own_revert (boolean): Check that we don't have reverted one of our commits in the pull request. Default: true.
    • boolean
• pr_checks_commits_spell
  • One of
    • object: Configuration used to check the spelling of the commits.
      • only_head (boolean): Default: true.
    • boolean
• pr_checks_pull_request_spell
  • One of
    • object: Configuration used to check the spelling of the title and body of the pull request.
      • only_head (boolean): Default: true.
    • boolean
• pr_checks_pull_request_labels (boolean): According the create changelog configuration.
• pr_checks_add_issue_link (boolean)
• 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".
      • 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)
        • test_args: The arguments to pass to the Snyk container test command. Default: ["--app-vulns", "--severity-threshold=critical"].
          • One of
            • array
              • Items (string)
• 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)
• 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)
• 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)
• print_versions (object): The print versions configuration.
  • versions (array): Default: [{"name": "c2cciutils", "cmd": ["c2cciutils", "--version"]}, {"name": "python", "cmd": ["python3", "--version"]}, {"name": "pip", "cmd": ["python3", "-m", "pip", "--version"]}, {"name": "twine", "cmd": ["twine", "--version"]}, {"name": "node", "prefix": "node ", "cmd": ["node", "--version"]}, {"name": "npm", "prefix": "npm ", "cmd": ["npm", "--version"]}, {"name": "make", "cmd": ["make", "--version"], "prefix": "make "}, {"name": "docker", "cmd": ["docker", "--version"]}, {"name": "docker-compose", "cmd": ["docker-compose", "--version"]}, {"name": "java", "cmd": ["java", "-version"]}, {"name": "kubectl", "cmd": ["kubectl", "version"]}, {"name": "helm", "cmd": ["helm", "version"]}].
    • 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.
  • 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.