x-pack/metricbeat: add BuildSystemTestBinary deprecation guidance#50196
x-pack/metricbeat: add BuildSystemTestBinary deprecation guidance#50196github-actions[bot] wants to merge 2 commits intomainfrom
Conversation
Align x-pack/metricbeat BuildSystemTestBinary with the deprecation UX used in other magefiles so developers get consistent guidance when invoking the target.\n\nKeep the existing x-pack/metricbeat Windows-specific test binary build behavior and only add the deprecation doc comment plus warning output.\n\nAssisted-By: GitHub Copilot CLI\nCo-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
This pull request doesn't have a |
|
This pull request does not have a backport label.
To fixup this pull request, you need to add the backport labels for the needed
|
This PR only adjusts deprecation guidance text and does not change user-facing behavior, so the changelog fragment is removed to align with skip-changelog policy. Assisted-By: GitHub Copilot CLI Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Done: I removed the changelog fragment and pushed the change to this PR branch. I can’t set PR labels from the tools available in this run, so I wasn’t able to add What is this? | From workflow: Mention in PR Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not. |
There was a problem hiding this comment.
Pull request overview
This PR aligns x-pack/metricbeat’s mage UX with other beats by adding the standard BuildSystemTestBinary deprecation guidance (GoDoc Deprecated: comment + runtime warning) while preserving the existing x-pack metricbeat-specific build behavior.
Changes:
- Mark
BuildSystemTestBinaryas deprecated via GoDocDeprecated:guidance describing the TestMain behavior. - Print the standard deprecation warning message when
BuildSystemTestBinaryruns (consistent with other magefiles). - Keep the existing Windows 32-bit
-ldflags=-whandling in the x-pack metricbeat-specific test binary build.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| } | ||
|
|
||
| // BuildSystemTestBinary build a system test binary depending on the runner. | ||
| // Deprecated: BuildSystemTestBinary builds a binary instrumented for use with Python system tests. |
There was a problem hiding this comment.
Why do we still need this target at all then? This is only used internally AFAIK if we don't need it remove it.
There was a problem hiding this comment.
If the Python tests still need it to function it isn't deprecated it's necessary
Summary
BuildSystemTestBinarydeprecation UX used in other magefiles tox-pack/metricbeat/magefile.goDeprecated:and prints the existing warning text before running the current x-pack metricbeat-specific build logic-ldflags=-wbehavior intactWhy
Developers invoking
mage BuildSystemTestBinaryinx-pack/metricbeatwere missing the migration guidance shown in other beats, creating inconsistent command UX.Validation
mage -lfromx-pack/metricbeatbutmageis not installed in this runnergo test -tags mage ./x-pack/metricbeat(the run was interrupted by environment module download constraints before completion)Refs #50158
What is this? | From workflow: Mention in Issue
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.