elastic / docs-tools

A place to put documentation tooling
4 stars 13 forks source link

Plugin doc generation: preserve content in logstash-docs if no version bump (integrations) #79

Closed karenzone closed 2 years ago

karenzone commented 2 years ago

Version 2.0 of issue #45 and PR #72 to add same [wonderful, time-saving!] logic for integration component plugins.

"Destination Wins"

A plugin version bump triggers the docgen scripts to pick up doc changes for inclusion in a PR. If there isn't a version bump, the script should not pick up doc content. When it does, I often have to back out the changes to pass CI and avoid breaking the docs build.

The fix implemented in #72 works for stand-alone plugins, but does not appear to be working for plugins that are part of an integration (codec-cloudtrail and codec-cloudwatch that belong to the AWS integration, for example). While we're working through some docgen kinks, I made manual updates to those two codecs. The next docgen stomped my changes:

In the docs, these codecs are "children" of the aws integration rather than stand-alone plugins. That's why I think the fix for stand-alone plugins doesn't cover them.