Skip to content

Conversation

@exceptionfactory
Copy link
Contributor

Summary

NIFI-14374 Sets deterministic ordering for several unordered elements in the Extension Manifest XML Documentation.

Changes to the XmlDocumentWriter include adding sorting to the following unordered collections:

  • Sorted Relationship documentation elements based on name field
  • Sorted Resource Type documentation elements based on enumeration name method
  • Sorted Property Dependencies based on dependent Property Name
  • Sorted Dependent Values based on natural String ordering

These changes retain compatibility with current output formatting, but provide deterministic behavior for the ordered elements. Deterministic ordering is a requirement for reproducible builds and these changes address issues related to extension-manifest.xml identified in with a comparison of Apache NiFi 2.3.0.

Changes include a new unit test for the XmlDocumentWriter that verifies expected ordering.

Tracking

Please complete the following tracking steps prior to pull request creation.

Issue Tracking

Pull Request Tracking

  • Pull Request title starts with Apache NiFi Jira issue number, such as NIFI-00000
  • Pull Request commit message starts with Apache NiFi Jira issue number, as such NIFI-00000

Pull Request Formatting

  • Pull Request based on current revision of the main branch
  • Pull Request refers to a feature branch with one commit containing changes

- Sorted Relationship documentation elements based on name field
- Sorted Resource Type documentation elements based on enumeration name method
- Sorted Property Dependencies based on dependent Property Name
- Sorted Dependent Values based on natural String ordering
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.

3 participants