Research: Plugin docgen without docbuild#1839
Merged
karenzone merged 2 commits intoelastic:mainfrom Apr 17, 2025
Merged
Conversation
Contributor
Author
|
Thank you so much for your help with this, @mashhurs! Now, instead of an error log with file names and lots of manual fixes to make, I get a PR that I can make quick fixes on. |
Open
2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What would happen if we skip the docbuild step in the GitHub action so that we can get output in a PR?
Could we push the generated plugin output into a PR? Then the docs-ci on the PR would run and fail because the
include_pathvariable would be over-written with the invalid path from plugin source. BUT, we'd have some output to work with! We'd have a definitive list of changed plugins, and fixing the path using GitHub suggestions would be easy.Micro goal: Get a PR that contains doc output that I can adjust in order to avoid all of the manual steps required in https://github.com/elastic/logstash-docs-md/issues/16.