Skip to content

Doc: Set version attribute in plugin source file #308

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 5 commits into from
May 11, 2022

Conversation

karenzone
Copy link
Contributor

@karenzone karenzone commented Apr 18, 2022

Related to plugin versioning work in elastic/docs-tools#70 and elastic/docs-tools#73.
The stack version attributes must be (calculated and) set on a per file basis, as the stack version will increment over time. I believe that this approach represents the right place to set those attributes.

Notes

  • I've used conditionals to ensure that the version attributes are set for the Versioned Plugin Reference only.
    • Why? The Logstash Reference is stack versioned, and we don't want the VPR approximations to interfere by causing unintended consequences.
  • When tested and approved, these attribute settings need to be added for each plugin affected by versioning problems (output-elasticsearch, input-beats, etc.) Don't worry... I know the list. 😄
  • When the versioning work has been implemented and fully functional, the VPR will need some cleanup to remove past "band-aids" to versioning.
    • When the cleanup work is complete, I'll remove the attribute resets at the end of each source file.

@karenzone
Copy link
Contributor Author

cc:/ @mashhurs

@@ -2,6 +2,11 @@
:type: input
:default_codec: plain

ifeval::["{versioned_docs}"=="true"]
:branch: %BRANCH%
:ecs_version: %BRANCH%

Choose a reason for hiding this comment

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

Shouldn't we set ECS version here? :ecs_version: %ECS_VERSION%?

Copy link

@mashhurs mashhurs left a comment

Choose a reason for hiding this comment

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

LGTM!

@karenzone
Copy link
Contributor Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants