Skip to content

NIFI-11524 Documentation and config experience improvement for ExecuteStreamCommand#7228

Closed
nandorsoma wants to merge 2 commits into
apache:mainfrom
nandorsoma:NIFI-11524-executestreamcommand-doc
Closed

NIFI-11524 Documentation and config experience improvement for ExecuteStreamCommand#7228
nandorsoma wants to merge 2 commits into
apache:mainfrom
nandorsoma:NIFI-11524-executestreamcommand-doc

Conversation

@nandorsoma
Copy link
Copy Markdown
Contributor

Summary

NIFI-11524

This PR indends to add documentation for the ExecuteSteamCommand processor and improves the configuration experience by adding dependency between properties.

I've noticed that the processor adds every Dynamic Property as environment variable even when it is a command argument. I didn't change this behavior because it might introduce a breaking change, but I'd change this behavior in a separate 2.0 only PR. Simply adding another regex check there would introduce the 4. regex check which is quite ugly so it would be a good opportunity for refactor. Another option would be to add validation for environment variables to ensure they don't contain . character, because most shells don't support it. But I'm not sure about that because there are commands that can utilize such env variables even though they are not common.

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

Verification

Please indicate the verification steps performed prior to pull request creation.

Build

  • Build completed using mvn clean install -P contrib-check
    • JDK 11
    • JDK 17

Licensing

  • New dependencies are compatible with the Apache License 2.0 according to the License Policy
  • New dependencies are documented in applicable LICENSE and NOTICE files

Documentation

  • Documentation formatting appears as expected in rendered files

Copy link
Copy Markdown
Contributor

@exceptionfactory exceptionfactory left a comment

Choose a reason for hiding this comment

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

Thanks for the additional documentation and improvements @nandorsoma! I just noted a couple very minor things, otherwise this should be ready to go.

@nandorsoma
Copy link
Copy Markdown
Contributor Author

Thank you for your review @exceptionfactory! Please see my latest commit where I applied your suggestions.

Copy link
Copy Markdown
Contributor

@exceptionfactory exceptionfactory left a comment

Choose a reason for hiding this comment

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

Thanks for making the adjustments @nandorsoma, the latest version looks good! +1 merging

exceptionfactory pushed a commit that referenced this pull request May 11, 2023
This closes #7228

Signed-off-by: David Handermann <exceptionfactory@apache.org>
(cherry picked from commit 2049d50)
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