Skip to content

Commit

Permalink
Simplify build.
Browse files Browse the repository at this point in the history
  • Loading branch information
SebastianStehle committed Sep 1, 2024
1 parent d4a6620 commit 582a999
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 36 deletions.
37 changes: 4 additions & 33 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,25 +20,11 @@ jobs:
- name: Compile
run: ./gradlew compileJava

test:
needs: [ compile ]
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v3

- name: Set up Java
id: setup-jre
uses: actions/setup-java@v1
with:
java-version: "11"
architecture: x64

- name: Test - Start Compose
run: docker-compose up -d
run: docker compose up -d
working-directory: tests

- name: Test
- name: Test - RUN
run: ./gradlew test
env:
CONFIG__WAIT: 60
Expand All @@ -54,26 +40,11 @@ jobs:

- name: Test - Cleanup
if: always()
run: docker-compose down
run: docker compose down
working-directory: tests

publish:
needs: [ compile, test ]
if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
runs-on: ubuntu-latest

steps:
- name: Checkout repo
uses: actions/checkout@v3

- name: Set up Java
id: setup-jre
uses: actions/setup-java@v1
with:
java-version: "11"
architecture: x64

- name: Publish to maven
if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
run: |
./gradlew publish
env:
Expand Down
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Squidex Java Library

[![Maven Central](https://img.shields.io/maven-central/v/io.squidex/squidex)](https://central.sonatype.com/artifact/io.squidex/squidex)
[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
[![Maven Central](https://img.shields.io/maven-central/v/io.squidex/squidex)](https://central.sonatype.com/artifact/io.squidex/squidex)

The Squidex Java SDK provides convenient access to the Squidex API from Java.

Expand Down Expand Up @@ -51,7 +50,15 @@ System.out.println("Received response from Squidex: " + rules);
## Staged Builders (v1.X)

The generated builders all follow the staged builder pattern. Read more [here](https://immutables.github.io/immutable.html#staged-builder).
Staged builders only allow you to build the object once all required properties have been specified.
Staged builders only allow you to build the object once all required properties have been specified.

## Major changes in 2.0

This SDK is mainly based on code generation, based on the OpenAPI specification from the Squidex API.

The initial version was built with fern: https://www.buildwithfern.com/. The main reason was the overall code quality and the support for discriminators. When the 1.0 version was released fern has not defined the pricing yet and unfortunately the current pricing is too expensive.

Therefore the SDK code generation was moved to OpenAPI Generator: (https://openapi-generator.tech/). The goal was to be as close to the previous version as possible without doing too much changes to the code generation templates. It was not possible to provide the same method signatures.

## Custom Templates

Expand Down

0 comments on commit 582a999

Please sign in to comment.