Skip to content

Skip doc generation if no plugin version up. #72

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 3 commits into from
Apr 1, 2022
Merged

Skip doc generation if no plugin version up. #72

merged 3 commits into from
Apr 1, 2022

Conversation

mashhurs
Copy link
Contributor

Description

Issue: #45
Currently, reference doc generator generates and rewrites the docs. Although there is no plugin version release, there might be a content change. For this case, we usually revert back to original version to avoid doc breakings.

Example cases:

Closes: #45

This PR introduces the skip-existing option for the reference doc generator. When applying this option results no-override existing docs.

Test

  • This logic will be consolidated into existing Reference Doc Generation workflow.
  • On my local, changed the contents without touching version numbers, executed following command:
    bundle exec ruby plugindocs.rb --skip-existing --output-path ../logstash-docs ../logstash/plugins_version_docs.json
    As a result, no version bumped plugins are skipped.
  • Executed the forked repo workflow and as a result doc update PR was created.

Copy link
Contributor

@kares kares left a comment

Choose a reason for hiding this comment

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

LGTM, couple minor suggestions left in-line

also given how smart --skip-existing is to check for :version: 🤔 if this is a behavior one would always want and thus have it on by default? (no strong feelings here but if anyone ever needs to run the tool manually he/she/it should end up with sensible defaults).

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.

Plugin doc generation: preserve content in logstash-docs if no version bump
2 participants