Skip to content

Commit

Permalink
revival
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathanlukas committed Jun 19, 2024
1 parent 5919037 commit 9fef934
Show file tree
Hide file tree
Showing 122 changed files with 3,709 additions and 2,818 deletions.
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---

name: Bug report
about: Create a report to help us improve
title: ''
labels: 'kind/bug'
assignees: ''

---

**Describe the bug**

<!-- A clear and concise description of what the bug is. -->

**To Reproduce**

<!--
Steps to reproduce the behavior
If possible add a minimal reproducer code sample
-->

**Expected behavior**

<!-- A clear and concise description of what you expected to happen. -->

**Log/Stacktrace**

<!-- If possible add the full stacktrace or log which contains the issue. -->

<details><summary>Full Stacktrace</summary>
<p>

```
<STACKTRACE>
```

</p>
</details>

**Environment:**
- OS: <!-- [e.g. Linux] -->
- Deployment: <!-- [SaaS or SM (Self Managed) and version] -->
- Spring-Zeebe Version: <!-- [e.g. 8.2.4] -->
- SpringBoot Version: <!-- [e.g. 2.7.x, 3.x.x] -->
- Configuration: <!-- [e.g. exporters etc.] -->
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---

name: Documentation issue
about: Changes to the documentation
title: ''
labels: 'kind/documentation'
assignees: ''

---

**Description**

A clear and concise description of what this issue is about.
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---

name: Feature request
about: Suggest an idea for this project
title: ''
labels: 'kind/feature'
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
46 changes: 0 additions & 46 deletions .github/workflows/gradle-publish.yml

This file was deleted.

23 changes: 23 additions & 0 deletions .github/workflows/mvn-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Build via Maven and run tests

on: [push, pull_request]

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Cache
uses: actions/cache@v4
with:
path: ~/.m2/repository
key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
restore-keys: |
${{ runner.os }}-maven-
- name: Set up JDK
uses: actions/setup-java@v4
with:
java-version: '21'
distribution: 'adopt'
- name: Build with Maven
run: mvn verify -PcheckFormat -B
58 changes: 58 additions & 0 deletions .github/workflows/mvn-release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# If this workflow is triggered by a push to either main or release branches then it
# deploys a SNAPSHOT
# If this workflow is triggered by publishing a Release, it
# deploys a RELEASE with the selected version
# updates the project version by incrementing the patch version
# commits the version update change to the repository's branch that triggered the workflow.
name: Deploy artifacts with Maven

on:
push:
branches:
- main
- release/**
release:
types: [ published ]
jobs:
publish:
runs-on: ubuntu-22.04
steps:

- name: Check out code
uses: actions/checkout@v4

- name: Set up Java environment
uses: actions/setup-java@v4
with:
java-version: '21'
distribution: 'adopt'
cache: maven
gpg-private-key: ${{ secrets.MAVEN_CENTRAL_GPG_SIGNING_KEY_SEC }}
gpg-passphrase: MAVEN_CENTRAL_GPG_PASSPHRASE

- name: Deploy SNAPSHOT / Release
uses: camunda-community-hub/community-action-maven-release@v1
with:
release-version: ${{ github.event.release.tag_name }}
maven-url: s01.oss.sonatype.org
nexus-usr: ${{ secrets.NEXUS_USR }}
nexus-psw: ${{ secrets.NEXUS_PSW }}
maven-usr: ${{ secrets.MAVEN_CENTRAL_DEPLOYMENT_USR }}
maven-psw: ${{ secrets.MAVEN_CENTRAL_DEPLOYMENT_PSW }}
maven-additional-options: -U
maven-gpg-passphrase: ${{ secrets.MAVEN_CENTRAL_GPG_SIGNING_KEY_PASSPHRASE }}
maven-auto-release-after-close: true
github-token: ${{ secrets.GITHUB_TOKEN }}
branch: ${{ github.event.release.target_commitish || github.ref_name }}
id: release

- if: github.event.release
name: Attach artifacts to GitHub Release (Release only)
uses: actions/upload-release-asset@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
upload_url: ${{ github.event.release.upload_url }}
asset_path: ${{ steps.release.outputs.artifacts_archive_path }}
asset_name: ${{ steps.release.outputs.artifacts_archive_path }}
asset_content_type: application/zip
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
HELP.md
.gradle
build/
target
!gradle/wrapper/gradle-wrapper.jar
!**/src/main/**/build/
!**/src/test/**/build/
Expand Down
4 changes: 2 additions & 2 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Code of Conduct
# Code of Conduct

### View the [Camunda Code of Conduct](https://camunda.com/events/code-conduct/) and find ways to report violations.
### View the [Camunda Code of Conduct](https://camunda.com/events/code-conduct/) and find ways to report violations.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ These are roles that are not code-based, but require some knowledge in that you
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
- [GitHub Help](https://help.github.com)
- [CODE_OF_CONDUCT](https://github.com/camunda-community-hub/community/blob/main/CODE_OF_CONDUCT.MD)
- [CODE_OF_CONDUCT](https://github.com/camunda-community-hub/community/blob/main/CODE_OF_CONDUCT.MD)
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
![Compatible with: Camunda Platform 8](https://img.shields.io/badge/Compatible%20with-Camunda%20Platform%208-0072Ce)
[![](https://img.shields.io/badge/Lifecycle-Incubating-blue)](https://github.com/Camunda-Community-Hub/community/blob/main/extension-lifecycle.md#incubating-)

# DEPRECATED

:information_source: **This project is no more maintained** and you should start using the project provided as part of the [Spring Zeebe project](https://github.com/camunda-community-hub/spring-zeebe). If you want to use it outside of the Spring Zeebe client, you can directly use the [java-operate-client](https://github.com/camunda-community-hub/spring-zeebe/tree/main/camunda-sdk-java/java-client-operate).
# Camunda Operate Client

This project is designed to simplify communication between a Java backend and the [Operate API of Camunda Platform 8](https://docs.camunda.io/docs/apis-clients/operate-api/).

Expand Down Expand Up @@ -44,7 +42,7 @@ CamundaOperateClient client = new CamundaOperateClient.Builder().authentication(

## Getting and Searching

When you search objects, you can get results as List or as SearchResult. The SearchResult gives you a sortValues that you can use to paginate your results :
When you search objects, you can get results as List or as SearchResult. The SearchResult gives you a sortValues that you can use to paginate your results :

```java
SearchQuery query = new SearchQuery.Builder().filter(someFilter).sort(new Sort("name", SortOrder.ASC)).size(20).searchAfter(previousResult.getSortValues()).build();
Expand Down Expand Up @@ -75,7 +73,7 @@ SearchQuery instanceQuery = new SearchQuery.Builder().filter(instanceFilter).siz
List<ProcessInstance> list = client.searchProcessInstances(instanceQuery);

SearchResult<ProcessInstance> result = client.searchProcessInstanceResults(instanceQuery);

//get a process instance by its key
ProcessInstance instance = client.getProcessInstance(instances.get(0).getKey());
```
Expand All @@ -89,7 +87,7 @@ FlownodeInstanceFilter flownodeFilter = new FlownodeInstanceFilter.Builder()
SearchQuery flownodeQuery = new SearchQuery.Builder().filter(flownodeFilter).size(20).sort(new Sort("state", SortOrder.ASC)).build();

List<FlownodeInstance> flownodes = client.searchFlownodeInstances(flownodeQuery);

//get a flownode instance by its key
FlownodeInstance flownodes = client.getFlownodeInstance(flownodes.get(0).getKey());
```
Expand All @@ -102,19 +100,19 @@ VariableFilter variableFilter = new VariableFilter.Builder().processInstanceKey(
SearchQuery varQuery = new SearchQuery.Builder().filter(variableFilter).size(5).sort(new Sort("name", SortOrder.ASC)).build();

List<Variable> variables = client.searchVariables(varQuery);

//get a variable by its key
Variable var = client.getVariable(variables.get(0).getKey());
```

### Incidents

```java
```java
//search incidents based on filters
IncidentFilter incidentFilter = new IncidentFilter.Builder().creationTime(new DateFilter(new Date(), DateFilterRange.YEAR)).build();
SearchQuery incidentQuery = new SearchQuery.Builder().filter(incidentFilter).size(20).sort(new Sort("state", SortOrder.ASC)).build();
List<Incident> incidents = client.searchIncidents(incidentQuery);

//get a incident by its key
Incident incident = client.getIncident(incidents.get(0).getKey());
```
Expand All @@ -129,7 +127,7 @@ SimpleAuthentication sa = new SimpleAuthentication("demo", "demo", "http://local
CamundaOperateClient client = new CamundaOperateClient.Builder().beta().operateUrl("http://localhost:8081").authentication(sa).build();

JsonNode json = ((CamundaOperateBetaClient) client).getFlowNodeStates(2L);

AuditTrail auditTrail = ((CamundaOperateBetaClient) client).getAuditTrail(2L);
```

Expand All @@ -140,9 +138,9 @@ You can import it to your maven or gradle project as a dependency

```xml
<dependency>
<groupId>io.camunda</groupId>
<artifactId>camunda-operate-client-java</artifactId>
<version>8.3.0.1</version>
<groupId>io.camunda</groupId>
<artifactId>camunda-operate-client-java</artifactId>
<version>8.3.0.1</version>
</dependency>
```

Expand Down
Loading

0 comments on commit 9fef934

Please sign in to comment.