cds:version

Full name:

com.sap.cds:cds-maven-plugin:2.9.0:version

Description:

Prints detailed version information about the CAP Java project on the console.
Call cds:version or mvn com.sap.cds:cds-maven-plugin:version to get detailed version information.

This goal shows the following version information about the CAP Java project and build environment:

  • version of CAP Java SDK including CDS4J
  • console output of command line cds version
  • version and location of Apache Maven
  • version and location of Java runtime
  • OS information

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator goal.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 1.19.0.
  • Binds by default to the lifecycle phase: generate-sources.

Optional Parameters

Name Type Since Description
<boundary> String - The begin and end boundary around the version output. After the begin boundary, a new line is printed before the version output starts. The boundaries are helpful to indicate the location of the version output within the whole Maven console output, if it's parsed by another application.
Default: ================================================================================
User Property: cds.version.boundary
<cdsdkVersion> String 2.4.0 Version of @sap/cds-dk to use with npx, by suppling --package @sap/cds-dk@<version>. The value has to be a valid semantic version.
User Property: cds.cdsdk-version
<environmentVariables> Map<String,String> 1.26.0 Additional environment variables to set on the command line.
<excludeCds> boolean - Exclude cds versions from version output.
Default: false
User Property: cds.version.excludeCds
<json> boolean - Indicates whether the version output is in JSON or plain text.
Default: false
User Property: cds.version.json
<npmRegistry> String - URL of NPM registry to use.
User Property: cds.npm.registry
<skip> boolean - Skip execution of this goal.
Default: false
User Property: cds.version.skip
<workingDirectory> File - The working directory to use during cds command execution. If not specified, the goal uses the directory containing a .cdsrc.json or package.json file. It goes up the project hierarchy on the file system until one of these files is found or the top-level project directory is reached.

Parameter Details

<boundary>
The begin and end boundary around the version output. After the begin boundary, a new line is printed before the version output starts. The boundaries are helpful to indicate the location of the version output within the whole Maven console output, if it's parsed by another application.
  • Type: java.lang.String
  • Required: No
  • User Property: cds.version.boundary
  • Default: ================================================================================

<cdsdkVersion>
Version of @sap/cds-dk to use with npx, by suppling --package @sap/cds-dk@<version>. The value has to be a valid semantic version.
  • Type: java.lang.String
  • Since: 2.4.0
  • Required: No
  • User Property: cds.cdsdk-version

<environmentVariables>
Additional environment variables to set on the command line.
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Since: 1.26.0
  • Required: No

<excludeCds>
Exclude cds versions from version output.
  • Type: boolean
  • Required: No
  • User Property: cds.version.excludeCds
  • Default: false

<json>
Indicates whether the version output is in JSON or plain text.
  • Type: boolean
  • Required: No
  • User Property: cds.version.json
  • Default: false

<npmRegistry>
URL of NPM registry to use.
  • Type: java.lang.String
  • Required: No
  • User Property: cds.npm.registry
Skip execution of this goal.
  • Type: boolean
  • Required: No
  • User Property: cds.version.skip
  • Default: false

<workingDirectory>
The working directory to use during cds command execution. If not specified, the goal uses the directory containing a .cdsrc.json or package.json file. It goes up the project hierarchy on the file system until one of these files is found or the top-level project directory is reached.
  • Type: java.io.File
  • Required: No