Skip to content

feat: readme update for xml record builder #152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 29, 2025
Merged

feat: readme update for xml record builder #152

merged 1 commit into from
Jun 29, 2025

Conversation

Joel-hanson
Copy link
Contributor

Description

Update readme with information on how to use the XmlMQRecordBuilder

Type of change

  • This change requires a documentation update

How Has This Been Tested?

Tested it with unit tests

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Copy link
Contributor

@dalelane dalelane left a comment

Choose a reason for hiding this comment

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

Note that we should change the commit message to start with docs: instead of feat: (as "feat" indicates a commit that introduces a new feature) but we can fix that on merge

README.md Outdated
To enable the XML record builder, add the following properties to your connector configuration:

```java
connectorConfigProps.put("mq.record.builder", "com.ibm.eventstreams.kafkaconnect.plugins.xml.XmlMQRecordBuilder");
Copy link
Contributor

Choose a reason for hiding this comment

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

what is "connectorConfigProps"?

Why wouldn't you configure it through normal connector config?

Signed-off-by: Joel Hanson <joelhanson025@gmail.com>
@dalelane dalelane merged commit b4e1591 into main Jun 29, 2025
2 checks passed
@dalelane dalelane deleted the mq-xml-builder branch June 29, 2025 22:34
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.

2 participants