Skip to content

Upgrade and refine for 8.8.7#176

Merged
sbuettner merged 5 commits intomainfrom
upgrad-and-refine-for-8.8.7
Feb 2, 2026
Merged

Upgrade and refine for 8.8.7#176
sbuettner merged 5 commits intomainfrom
upgrad-and-refine-for-8.8.7

Conversation

@sbuettner
Copy link
Contributor

Important

This requires the release of Connectors 8.8.7 to be finished and available on maven public.

Issue

Relates to https://github.com/camunda/team-connectors/issues/1096

Description

This pull request modernizes and simplifies the Camunda Outbound Connector template by removing legacy files, updating documentation, and adopting the latest annotation-based approach for connector development. It consolidates the example to focus on a single, annotation-driven connector, updates dependencies, and aligns the element template and build configuration accordingly.

Connector implementation and template modernization:

  • Introduced a new annotation-based connector class MyConnector in src/main/java/io/camunda/example/MyConnector.java, supporting multiple operations (echo and addTwoNumbers) via the @Operation annotation, and removed the legacy record MyConnectorResult. [1] [2]
  • Replaced and renamed the element template to element-templates/my-connector.json, updating its operations, properties, and metadata to match the new connector, and removed obsolete template files. [1] [2] [3] [4] [5] [6] [7]

Documentation updates:

  • Overhauled README.md to focus on the annotation-based OutboundConnectorProvider approach, updated all class and file references, clarified instructions, and improved the input parameter documentation. [1] [2] [3] [4] [5]

Build and dependency updates:

  • Updated Maven dependencies in pom.xml to the latest compatible versions, removed unused test dependencies, and aligned the element template generator configuration with the new connector and template files. [1] [2] [3]

Cleanup of legacy files and configurations:

  • Removed .tool-versions file to eliminate unused Java and Maven version pinning.

Simplify the test setup
Add test for incident creation
Removed unused resources
Adapt the README.md
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Modernizes the Camunda Outbound Connector template for the 8.8.7 connector SDK line by removing legacy implementations and consolidating around the annotation-based Operations API, updating templates/docs/tests accordingly.

Changes:

  • Replaced legacy connector implementations with a single annotation-driven OutboundConnectorProvider (MyConnector) supporting multiple @Operations.
  • Updated element template(s), BPMN test process, and integration tests to match the new connector type/template IDs and the echo operation.
  • Upgraded Maven dependency versions and simplified test/runtime scaffolding and docs.

Reviewed changes

Copilot reviewed 21 out of 23 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
src/main/java/io/camunda/example/MyConnector.java New annotation-based connector provider with echo and addTwoNumbers operations.
src/main/java/io/camunda/example/model/EchoRequest.java New request model aligned to the echo operation and template generator annotations.
src/main/java/io/camunda/example/model/EchoResponse.java New response model for the echo operation output.
src/main/java/io/camunda/example/model/Authentication.java Moved/renamed authentication model and updated template property metadata.
src/main/resources/META-INF/services/io.camunda.connector.api.outbound.OutboundConnectorProvider Updated SPI registration to load MyConnector via ServiceLoader.
src/main/resources/META-INF/services/io.camunda.connector.api.outbound.OutboundConnectorFunction Removed SPI entry for the legacy OutboundConnectorFunction implementation.
src/main/resources/icon.svg Added icon resource referenced by the connector/element template metadata.
src/test/java/io/camunda/example/integration/TestConnectorRuntimeApplication.java Simplified Spring Boot test app used by integration tests.
src/test/java/io/camunda/example/integration/MyConnectorIntegrationTest.java Updated/expanded integration tests to validate the echo operation and failure behavior.
src/test/java/io/camunda/example/LocalConnectorRuntime.java Updated rememberable package/name for the local runtime helper app (still test-scope).
src/test/resources/bpmn/operation-connector-test-process.bpmn Updated BPMN test process to use the new template/type IDs and the echo operation.
src/test/resources/application.properties Updated Camunda client property keys for the newer client configuration style.
element-templates/my-connector.json Replaced prior template(s) with a new template matching the updated connector and operations.
element-templates/template-connector.json Removed obsolete legacy element template file.
src/main/java/io/camunda/example/operations/MyConnectorProvider.java Removed old operations-based provider implementation in favor of MyConnector.
src/main/java/io/camunda/example/classic/MyConnectorFunction.java Removed legacy OutboundConnectorFunction implementation.
src/main/java/io/camunda/dto/MyConnectorResult.java Removed legacy DTO replaced by EchoResponse.
src/test/java/io/camunda/example/classic/MyFunctionTest.java Removed tests for the legacy classic connector implementation.
src/test/java/io/camunda/example/classic/MyRequestTest.java Removed tests for legacy request binding/validation paths.
README.md Reworked documentation to describe the annotation-based provider approach and updated references.
pom.xml Bumped connector/camunda versions and updated element-template-generator plugin config for the new connector/template.
.tool-versions Removed tool version pinning file.
Comments suppressed due to low confidence (2)

src/test/java/io/camunda/example/LocalConnectorRuntime.java:14

  • LocalConnectorRuntime is under src/test/java, so it won’t be present in the packaged artifact. If the intent is for users of the template to run the connector locally via this main class (as described in the README), consider moving it to src/main/java (or alternatively adjusting docs to state it’s test-scope).
    src/test/java/io/camunda/example/integration/TestConnectorRuntimeApplication.java:13
  • This test application was simplified to an empty @SpringBootApplication, but it still imports a number of now-unused types (e.g., DocumentFactory*, SpringApplication, ImportAutoConfiguration, ElasticsearchRestClientAutoConfiguration, @Bean/@Primary, @MockitoBean). Please remove the unused imports to avoid confusion about required test configuration.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link

@johnBgood johnBgood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small comment/idea, and I guess Copilot comments make sense.
Great improvement, thank you!

@sbuettner sbuettner merged commit 3ab6cab into main Feb 2, 2026
2 of 3 checks passed
@sbuettner sbuettner deleted the upgrad-and-refine-for-8.8.7 branch February 2, 2026 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants