sap-jenkins-library/resources/metadata/versioning.yaml

metadata:
  name: artifactPrepareVersion
  aliases:
    - name: artifactSetVersion
    - name: mavenExecute
    - name: setVersion
      deprecated: true
  description: Prepares and potentially updates the artifact's version before building the artifact.
  longDescription: |-
    Prepares and potentially updates the artifact's version before building the artifact.

    The continuous delivery process requires that each build is done with a unique version number.
    There are two common patterns found:

    ### 1. Continuous Deployment pattern with automatic versioning

    The team has full authority on `<major>.<minor>.<patch>` and can increase any part whenever required.
    Nonetheless, the automatic versioning makes sure that every build will create a unique version by appending `<major>.<minor>.<patch>` with a buildversion (we use a timestamp) and optinally the commitId.

    In order to represent this version also in the version control system the new unique version will be pushed with a dedicated tag (`<tagPrefix><major>.<minor>.<patch><unique extension>`).

    Depending on the build tool used and thus the allowed versioning format the `<unique extension>` varies.

    **Remarks:**

    * There is no commit to master since this would create a perpetuum mobile and just trigger the next automatic build with automatic versioning, and so on ...
    * Not creating a tag would lead to a loss of the final artifact version in scm which often is not acceptable
    * You need to ensure that your CI/CD system can push back to your SCM (via providing ssh or HTTP(s) credentials)

    **This pattern is the default** behavior (`versioningType: cloud`) since this is suitable for for most cloud deliveries.

    It is possible to use `versioningType: cloud_noTag` which has a slighly different behavior than described above:

    * The new version will NOT be written as tag into the SCM but it is only available in the corresponding CI/CD workspace
    * IMPORTANT NOTICE: Using the option `cloud_noTag` should not be picked in case you need to ensure a fully traceable path from SCM commit to your build artifact.

    ### 2. Pure version `<major>.<minor>.<patch>`

    This pattern is often used by teams that have cloud deliveries with no fully automated procedure, e.g. delivery after each takt.
    Another typical use-case is development of a library with regular releases where the versioning pattern should be consumable and thus ideally complies to a `<major>.<minor>.<patch>` pattern.

    The version is then either manually set by the team in the course of the development process or automatically pushed to master after a successful release.

    Unlike for the _Continuous Deloyment_ pattern descibed above, in this case there is no dedicated tagging required for the build process since the version is already available in the repository.

    Configuration of this pattern is done via `versioningType: library`.

    ### Support of additional build tools

    Besides the `buildTools` provided out of the box (like `maven`, `mta`, `npm`, ...) it is possible to set `buildTool: custom`.

    This allows you to provide automatic versioning for tools using a:

    #### file with the version as only content:

    Define `buildTool: custom` as well as `filePath: <path to your file>`

    **Please note:** `<path to your file>` need to point either to a `*.txt` file or to a file without extension.

    #### `ini` file containing the version:

    Define `buildTool: custom`, `filePath: <path to your ini-file>` as well as parameters `versionSection` and `versionSource` to point to the version location (section & parameter name) within the file.

    **Please note:** `<path to your file>` need to point either to a `*.cfg` or a `*.ini` file.

    #### `json` file containing the version:

    Define `buildTool: custom`, `filePath: <path to your *.json file` as well as parameter `versionSource` to point to the parameter containing the version.

    #### `yaml` file containing the version

    Define `buildTool: custom`, `filePath: <path to your *.yml/*.yaml file` as well as parameter `versionSource` to point to the parameter containing the version.    
spec:
  inputs:
    params:
      - name: buildTool
        type: string
        description: Defines the tool which is used for building the artifact. Supports `custom`, `dub`, `golang`, `maven`, `mta`, `npm`, `pip`, `sbt`.
        mandatory: true
        scope:
        - GENERAL
        - PARAMETERS
        - STAGES
        - STEPS
        possibleValues:
        - custom
        - docker
        - dub
        - golang
        - maven
        - mta
        - npm
        - pip
        - sbt
      - name: commitUserName
        aliases:
          - name: gitUserName
        type: string
        description: "Defines the user name which appears in version control for the versioning update (in case `versioningType: cloud`)."
        scope:
        - PARAMETERS
        - STAGES
        - STEPS
        default: Project Piper
      - name: customVersionField
        type: string
        description: "For `buildTool: custom`: Defines the field which contains the version in the descriptor file."
        scope:
        - PARAMETERS
        - STAGES
        - STEPS
      - name: customVersionSection
        type: string
        description: "For `buildTool: custom`: Defines the section for version retrieval in vase a *.ini/*.cfg file is used."
        scope:
        - PARAMETERS
        - STAGES
        - STEPS
      - name: customVersioningScheme
        type: string
        description: "For `buildTool: custom`: Defines the versioning scheme to be used (possible options `pep440`, `maven`, `semver2`)."
        scope:
        - PARAMETERS
        - STAGES
        - STEPS
      - name: dockerVersionSource
        type: string
        description: "For `buildTool: docker`: Defines the source of the version. Can be `FROM`, any supported _buildTool_ or an environment variable name."
        scope:
        - PARAMETERS
        - STAGES
        - STEPS
      - name: filePath
        type: string
        description: "Defines a custom path to the descriptor file. Build tool specific defaults are used (e.g. `maven: pom.xml`, `npm: package.json`, `mta: mta.yaml`)."
        scope:
        - PARAMETERS
        - STAGES
        - STEPS
      - name: globalSettingsFile
        aliases:
          - name: maven/globalSettingsFile
        type: string
        description:  Maven only - Path to the mvn settings file that should be used as global settings file.
        scope:
          - GENERAL
          - STEPS
          - STAGES
          - PARAMETERS
      - name: includeCommitId
        type: bool
        description: "Defines if the automatically generated version (`versioningType: cloud`) should include the commit id hash."
        scope:
        - PARAMETERS
        - STAGES
        - STEPS
        default: true
      - name: m2Path
        aliases:
          - name: maven/m2Path
        type: string
        description: Maven only - Path to the location of the local repository that should be used.
        scope:
          - GENERAL
          - STEPS
          - STAGES
          - PARAMETERS
      - name: password
        type: string
        description: Password/token for git authentication.
        scope:
        - PARAMETERS
        - STAGES
        - STEPS
        secret: true
      - name: projectSettingsFile
        aliases:
          - name: maven/projectSettingsFile
        type: string
        description: Maven only - Path to the mvn settings file that should be used as project settings file.
        scope:
          - GENERAL
          - STEPS
          - STAGES
          - PARAMETERS
      - name: shortCommitId
        type: bool
        description: Defines if a short version of the commitId should be used. GitHub format is used (first 7 characters).
        scope:
          - STEPS
          - STAGES
          - PARAMETERS
      - name: tagPrefix
        type: string
        description: "Defines the prefix which is used for the git tag which is written during the versioning run (only `versioningType: cloud`)."
        scope:
        - PARAMETERS
        - STAGES
        - STEPS
        default: build_
      - name: unixTimestamp
        type: bool
        description: Defines if the Unix timestamp number should be used as build number instead of the standard date format.
        scope:
          - STEPS
          - STAGES
          - PARAMETERS
      - name: username
        type: string
        description: User name for git authentication
        scope:
        - PARAMETERS
        - STAGES
        - STEPS
        secret: true
      - name: versioningTemplate
        type: string
        description: "DEPRECATED: Defines the template for the automatic version which will be created"
        mandatory: false
        scope:
        - PARAMETERS
        - STAGES
        - STEPS
      - name: versioningType
        type: string
        description: "Defines the type of versioning (`cloud`: fully automatic, `cloud_noTag`: automatic but no tag created, `library`: manual)"
        scope:
        - PARAMETERS
        - STAGES
        - STEPS
        default: cloud
    secrets:
    - name: gitHttpsCredentialsId
      type: jenkins
    - name: gitSshKeyCredentialsId
      type: jenkins
      aliases:
        - name: gitCredentialsId
          deprecated: true
  outputs:
    resources:
      - name: commonPipelineEnvironment
        type: piperEnvironment
        params:
          - name: artifactVersion
          - name: git/commitId
          - name: git/commitMessage