Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update installation of local cds-dk #1510

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
+71 −13
Open

Update installation of local cds-dk #1510

Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
46b26b2
Update installation of local cds-dk
mofterdinger Dec 10, 2024
4fdc797
Update building.md
mofterdinger Dec 10, 2024
52fbe3e
Update building.md
mofterdinger Dec 10, 2024
cde5ecd
Update building.md
mofterdinger Dec 10, 2024
12e3746
Update building.md
mofterdinger Dec 10, 2024
4c9eee9
Update java/developing-applications/building.md
mofterdinger Dec 12, 2024
6f7b054
Merge branch 'main' into mofterdinger-patch-2
mofterdinger Dec 12, 2024
20e177d
Update building.md
mofterdinger Dec 12, 2024
ee42ba0
Update building.md
mofterdinger Dec 12, 2024
fa5ba08
Update building.md
mofterdinger Dec 12, 2024
a9fe51c
Update building.md
mofterdinger Dec 12, 2024
bb34496
Update building.md
mofterdinger Dec 12, 2024
a672956
Update building.md
mofterdinger Dec 12, 2024
a94f473
Update building.md
mofterdinger Dec 13, 2024
508cef0
Merge branch 'main' into mofterdinger-patch-2
mofterdinger Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 71 additions & 13 deletions java/developing-applications/building.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,27 +377,85 @@ Use the _.cdsrc.json_ file to add project specific configuration of `@sap/cds-dk

### Using a Local cds-dk

By default, the build is configured to download a Node.js runtime and the `@sap/cds-dk` tools and install them locally within the project.
The `install-cdsdk` goal requires a version of `@sap/cds-dk`, which [needs to be provided explicitly](../../releases/archive/2022/oct22#important-changes-in-java) in the configuration. With this, you can ensure that the build is fully reproducible.
You can provide this version by adding the following property to the `properties` section in your `pom.xml`:

```xml
<properties>
...
<cds.install-cdsdk.version>FIXED VERSION</cds.install-cdsdk.version>
</properties>
Starting with version 3.6.0 of the `cds-services-archetype`, the default setup of a newly created CAP Java project has changed. The `@sap/cds-dk` is maintained as a `devDependency` in `package.json` and installed with an `npm ci` during the Maven build.
The `install-cdsdk` goal is no longer used to install the `@sap/cds-dk` locally and it's also marked as deprecated. The version of the `@sap/cds-dk` is no longer maintained in `pom.xml`, it's configured in the `package.json`:
```json
{
"devDependencies" : {
"@sap/cds-dk" : "^8.5.1",
}
}
```
A `package-lock.json` is also created during project creation with the `cds-services-archetype`. The lock file is needed for `npm ci` to run successfully and pins the transitive dependencies of @sap/cds-dk to fixed versions. Fixing the versions ensures that the CDS build is fully reproducible.

::: warning
Make sure to regularly update `@sap/cds-dk` according to [our guidance](../../releases/schedule).

For multitenant applications, ensure that the `@sap/cds-dk` version in the sidecar is in sync.
:::

#### Migrate from goal `install-cdsdk` to `npm ci`

To migrate from the deprecated goal `install-cdsdk` to the new `npm ci` approach, the following steps are required:

1. Remove execution of goal `install-cdsdk` from the `cds-maven-plugin` in `srv/pom.xml`:
```xml
<plugin>
<groupId>com.sap.cds</groupId>
<artifactId>cds-maven-plugin</artifactId>
<version>${cds.services.version}</version>
<executions>
<!-- Delete from here ... -->
<execution>
<id>cds.install-cdsdk</id>
<goals>
<goal>install-cdsdk</goal>
</goals>
</execution>
<!-- ... to here -->
```

2. Then add execution of goal `npm` with arguments `ci` instead to the `cds-maven-plugion` in `srv/pom.xml`:
```xml
<execution>
<id>cds.npm-ci</id>
<goals>
<goal>npm</goal>
</goals>
<configuration>
<arguments>ci</arguments>
</configuration>
</execution>
```

3. Remove cds-dk version property `<cds.install-cdsdk.version` from `pom.xml`:
```xml
<properties>
<!-- Delete from here ... -->
<cds.install-cdsdk.version>8.4.2</cds.install-cdsdk.version>
<!-- ... to here -->
</properties>
```

4. Add `@sap/cds-dk` as devDependency to `package.json`:
```json
{
"devDependencies" : {
"@sap/cds-dk" : "^8.5.0"
}
}
```

5. Perform `npm install` on the command line to get the `package-lock.json` created or updated.

6. Finally, do a `mvn clean install` and verify that the installation of `@sap/cds-dk` is done with the new approach.

#### Maintaining cds-dk

By default, the goal `install-cdsdk` of the `cds-maven-plugin` skips the installation of the `@sap/cds-dk`, if the `@sap/cds-dk` is already installed.
To update the `@sap/cds-dk` version in your application project do the following:
1. package.json and npm ci
Newly created CAP Java project are maintaining `@sap/cds-dk` as a devDependency in `package.json`, the version will also be maintained there. If the version is updated, it's necessary to do an npm install from the command line to update `package-lock.json`. The `npm ci` will then install the updated version of `@sap/cds-dk`.

2. Goal install-cdsdk
Older CAP Java may still use the `install-cdsdk` goal of the `cds-maven-plugin`. By default, the `install-cdsdk` goal skips the installation of `@sap/cds-dk`, if it's already installed.
To update the `@sap/cds-dk` version in your application project, do the following:

1. Specify a newer version of `@sap/cds-dk` in your *pom.xml* file.
2. Execute `mvn spring-boot:run` with an additional property `-Dcds.install-cdsdk.force=true`, to force the installation of a **`@sap/cds-dk`** in the configured version.
Expand Down
Loading