Skip to content

Commit

Permalink
Merge remote-tracking branch 'public/main' into release/update-2.x.x
Browse files Browse the repository at this point in the history
  • Loading branch information
wog48 committed Oct 18, 2024
2 parents f9d7d4a + 8297765 commit 59c7610
Show file tree
Hide file tree
Showing 256 changed files with 9,441 additions and 3,202 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/archetype.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ jobs:
distribution: 'temurin'
cache: maven
- name: 1. Build JPA
run: cd ./jpa && mvn clean -Dmaven.test.skip
run: cd ./jpa && mvn clean install -Dmaven.test.skip
- name: 2. Build and test archetype
run: cd ./jpa-archetype && mvn clean install archetype:integration-test
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ tmp/
*.md.html
local.properties
.loadpath


# Eclipse Core

# External tool builders
.externalToolBuilders/

Expand Down
15 changes: 5 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,12 @@ In case you need to report a bug, please provide the following information:

You are welcome to contribute code to the JPA Processor in order to fix bugs or to propose enhancements.

There are three important things to know:
There are four important things to know:

1. You must be aware of the Apache License (which describes contributions) and **agree to the Developer Certificate of Origin**. This is common practice in all major Open Source projects. To make this process as simple as possible, we are using *[CLA assistant](https://cla-assistant.io/)*. CLA assistant is an open source tool that integrates with GitHub very well and enables a one-click-experience for accepting the DCO. See the respective section below for details.
2. There are **some requirements regarding code style and quality** which need to be met (we also have to follow them). The respective section below gives more details on the coding guidelines.
3. **Not all proposed contributions can be accepted**. The code must fit the overall direction of the JPAProcessor and really improve it. For most bug fixes this is a given, but it could haven that design ideas get violated.

### Developer Certificate of Origin (DCO)

Due to legal reasons, contributors will be asked to accept a DCO when they create the first pull request to this project. SAP uses [the standard DCO text of the Linux Foundation](https://developercertificate.org/).

This happens in an automated fashion during the submission process: the CLA assistant tool will add a comment to the pull request. Click it to check the DCO, then accept it on the following screen. CLA assistant will save this decision for upcoming contributions.
1. You **have to** follow SAPs [contribution guidelines](https://github.com/SAP/.github/blob/main/CONTRIBUTING.md) as well as SAPs [AI-generated code contributions guidelines](https://github.com/SAP/.github/blob/main/CONTRIBUTING_USING_GENAI.md).
2. You must be aware of the Apache License (which describes contributions) and **agree to the Developer Certificate of Origin**, see the [contribution guidelines](https://github.com/SAP/.github/blob/main/CONTRIBUTING.md). This is common practice in all major Open Source projects. To make this process as simple as possible, we are using *[CLA assistant](https://cla-assistant.io/)*. CLA assistant is an open source tool that integrates with GitHub very well and enables a one-click-experience for accepting the DCO. See the respective section below for details.
3. There are **some requirements regarding code style and quality** which need to be met (we also have to follow them). The respective section below gives more details on the coding guidelines.
4. **Not all proposed contributions can be accepted**. The code must fit the overall direction of the JPAProcessor and really improve it. For most bug fixes this is a given, but it could haven that design ideas get violated.

### Contribution Content Guidelines

Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ clone the repository, import the projects and declare a dependency to either the
<dependency>
<groupId>com.sap.olingo</groupId>
<artifactId>odata-jpa-metadata</artifactId>
<version>2.1.3</version>
<version>2.2.0</version>
</dependency>
```

Expand All @@ -57,7 +57,7 @@ Or to the complete processor:
<dependency>
<groupId>com.sap.olingo</groupId>
<artifactId>odata-jpa-processor</artifactId>
<version>2.1.3</version>
<version>2.2.0</version>
</dependency>
```

Expand Down Expand Up @@ -103,3 +103,4 @@ Detailed information including third-party components and their licensing/copyri
|2.1.0| - Enhancement of annotation API<br>- Enhancement of API for server driven paging<br>- Optional support of IN operand <br>- Update to Olingo 5.0.0<br>- Rework $count implementation<br>- Fix problem with $count on collection properties|No|
|2.1.1| - Fix for issue [#292](https://github.com/SAP/olingo-jpa-processor-v4/issues/292)|No|
|2.1.3| - Fix for issue [#319](https://github.com/SAP/olingo-jpa-processor-v4/issues/319)<br> - Fix for issue [#325](https://github.com/SAP/olingo-jpa-processor-v4/issues/325)<br> - Fix for issue [#327](https://github.com/SAP/olingo-jpa-processor-v4/issues/327)<br> - Fix for issue [#331](https://github.com/SAP/olingo-jpa-processor-v4/issues/331)<br> - Fix of en issue with $orderby and _to one_ navigation properties |No|
|2.2.0| - Fix for issue [#378](https://github.com/SAP/olingo-jpa-processor-v4/issues/378)<br> - Fix for issue [#376](https://github.com/SAP/olingo-jpa-processor-v4/issues/376)<br> - Fix for issue [#361](https://github.com/SAP/olingo-jpa-processor-v4/issues/361)<br> - Fix for issue [#352](https://github.com/SAP/olingo-jpa-processor-v4/issues/352)<br> - Fix for issue [#307](https://github.com/SAP/olingo-jpa-processor-v4/issues/307) <br> - Enhancement according to [#314](https://github.com/SAP/olingo-jpa-processor-v4/issues/314)|No|
7 changes: 7 additions & 0 deletions additionalWords.directory
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,10 @@ MULTI
Asc
Validator
olingo
Concat
Postgresql
Hana
Desc
Crossjoin
Pageable
xml
8 changes: 4 additions & 4 deletions jpa-archetype/odata-jpa-archetype-spring/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

<parent>
<groupId>com.sap.olingo</groupId>
<artifactId>odata-jpa-archetype</artifactId>
<version>2.1.3</version>
<artifactId>odata-jpa-archetype</artifactId>
<version>2.2.0</version>
</parent>
<artifactId>odata-jpa-archetype-spring</artifactId>
<name>Archetype - odata-jpa-archetype-spring</name>
Expand All @@ -17,15 +17,15 @@
<extension>
<groupId>org.apache.maven.archetype</groupId>
<artifactId>archetype-packaging</artifactId>
<version>3.2.1</version>
<version>3.3.0</version>
</extension>
</extensions>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-archetype-plugin</artifactId>
<version>3.2.1</version>
<version>3.3.0</version>
<configuration>
<debug>true</debug>
</configuration>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
</parent>

<properties>
<processor.version>2.1.3</processor.version>
<processor.version>2.2.0</processor.version>
<java.version>17</java.version>
<build.sourceEncoding>UTF-8</build.sourceEncoding>
<eclipselink.version>4.0.3</eclipselink.version>
Expand Down
4 changes: 2 additions & 2 deletions jpa-archetype/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@
<modelVersion>4.0.0</modelVersion>
<groupId>com.sap.olingo</groupId>
<artifactId>odata-jpa-archetype</artifactId>
<version>2.1.3</version>
<version>2.2.0</version>
<packaging>pom</packaging>
<url>https://github.com/SAP/olingo-jpa-processor-v4</url>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.build.source>17</project.build.source>
<odata.jpa.version>2.1.3</odata.jpa.version>
<odata.jpa.version>2.2.0</odata.jpa.version>
</properties>

<modules>
Expand Down
8 changes: 4 additions & 4 deletions jpa-tutorial/Questions/HowToBuildServerDrivenPaging.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= How to build server driven paging?
= How to build server-driven paging?

== Introduction

Expand Down Expand Up @@ -51,7 +51,7 @@ it is worth to read the chapter, as it contains some general hints.

== Single service instance single thread

Implementing server driven paging, we must answer some questions. The first, general question, is how the skip-token should look like.
Implementing server-driven paging, we must answer some questions. The first, general question, is how the skip-token should look like.
There are two obvious options:

. The skip-token is a string that contains all the information needed to build the next page and to determine the last page.
Expand Down Expand Up @@ -241,7 +241,7 @@ Last step is to implement `getNextPage`:
<2> Check if this is the last page.
<3> Calculate the value of $top, which may be different for the last page.

We are done and can test our complete server driven paging.
We are done and can test our complete server-driven paging.

== Single service instance multiple threads

Expand Down Expand Up @@ -277,7 +277,7 @@ public class JPAExamplePagingProvider implements JPAODataPagingProvider {

== Multiple service instances
In case we have multiple instances of our service, the standard situation for microservices, we usually do not know which instance
will handle a request. It may or may not be the same that has handled the request before. This holds also true for server driven paging.
will handle a request. It may or may not be the same that has handled the request before. This holds also true for server-driven paging.
Therefore, we need to make the query information available for all instances, which requires a central backing service
that can be reached from each instance of our service. Two options will be described below.

Expand Down
Loading

0 comments on commit 59c7610

Please sign in to comment.