Skip to content

Commit 9de98aa

Browse files
committed
improve pipeline + README file + fix trial URL
1 parent e7c58d4 commit 9de98aa

File tree

3 files changed

+23
-5
lines changed

3 files changed

+23
-5
lines changed

.github/workflows/release.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1+
name: Publish Package to Nuget
12
on:
2-
push:
3-
tags:
4-
- "v[0-9]+.[0-9]+.[0-9]+"
3+
release:
4+
types: [published]
5+
56
permissions:
67
id-token: write
78

89
jobs:
910
build-and-publish:
1011
runs-on: ubuntu-latest
12+
environment: release
1113
permissions:
1214
id-token: write
1315

FlowableExternalWorkerClient/Client/ExternalWorkerClient.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ public class ExternalWorkerClient : IExternalWorkerClient
99
private FlowableExternalWorkerRestClient _flowableExternalWorkerRestClient;
1010

1111
public ExternalWorkerClient(
12-
string flowableHost = "https://cloud.flowable.com/work",
12+
string flowableHost = "https://trial.flowable.com/work",
1313
string? workerId = null,
1414
AuthenticationHeaderValue? authentication = null,
1515
IHttpClientCustomizer? customizer = null

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
[License:
55
![license](https://img.shields.io/hexpm/l/plug.svg)](https://github.com/flowable/flowable-external-client.net/blob/main/LICENSE)
66

7+
![Flowable Actions CI](https://github.com/flowable/flowable-external-client.net/actions/workflows/main.yml/badge.svg?branch=main)
8+
79
An _External Worker Task_ in BPMN or CMMN is a task where the custom logic of that task is executed externally to Flowable, i.e. on another server.
810
When the process or case engine arrives at such a task, it will create an **external job**, which is exposed over the REST API.
911
Through this REST API, the job can be acquired and locked.
@@ -13,12 +15,26 @@ This project makes implementing such custom logic in .NET easy by not having the
1315
Integrations for other languages are available, too.
1416

1517
This project is still a work-in-progress client, expect that the API will change.
16-
Currently, it's a basic wrapper for the REST API's without any further services.
18+
19+
## Authentication
20+
21+
This library uses the [AuthenticationHeaderValue](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.headers.authenticationheadervalue.-ctor?view=net-9.0) class to provide the authentication.
22+
This allows to provide a `Bearer` token as well as `Basic` authentication by providing the correct parameters.
23+
24+
## Installation
25+
26+
To install the external worker library, execute the following command:
27+
```
28+
dotnet add package Flowable.ExternalWorkerClient
29+
```
1730

1831
## Sample
1932

2033
### Cloud
2134

35+
The usage with Flowable Cloud is simpler, since everything is pre-configured.
36+
However, it's required to either use the user credentials or to pre-configure a personal access token.
37+
2238
```csharp
2339
var auth = new AuthenticationHeaderValue("Bearer", "<personal-access-token>");
2440

0 commit comments

Comments
 (0)