Skip to content

A logic to generate an empty plugin placeholder. #97

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
Sep 25, 2023

Conversation

mashhurs
Copy link
Contributor

@mashhurs mashhurs commented Sep 20, 2023

What does this PR?

  • Adds a logic to generate an empty placeholder for new plugin
    • currently we have an use-case for integration plugin only;
    • it uses common template which later on can be used to fill released notes and dates;
  • This change also adds a git helper to DRY.
    • git operations are used in both VPR docs generator and placeholder generator, so created a git helper to DRY;

Test

Related issue

require "octokit"
require_relative "git_helper"

class GeneratePluginPlaceholder < Clamp::Command
Copy link
Member

Choose a reason for hiding this comment

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

To avoid confusion with the plugin generator I suggest we scope the naming to include Docs

Suggested change
class GeneratePluginPlaceholder < Clamp::Command
class GeneratePluginDocsPlaceholder < Clamp::Command

Copy link
Contributor Author

Choose a reason for hiding this comment

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

WDTY for GeneratePluginPlaceholderDoc? Docs sounds the script generating non-single doc.

mashhurs and others added 2 commits September 22, 2023 11:26
@mashhurs mashhurs requested a review from jsvd September 22, 2023 19:58
Copy link
Member

@jsvd jsvd left a comment

Choose a reason for hiding this comment

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

LGTM

@mashhurs mashhurs merged commit 9dbe15b into elastic:main Sep 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

VPR: Adjust tooling to improve workflow for adding new integration plugin docs
2 participants