Skip to content
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

remove os.Args hack for backwards compatible arguments #42209

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

leehinman
Copy link
Contributor

@leehinman leehinman commented Jan 3, 2025


*** Breaking Change ***

Proposed commit message

This PR removes support for single - multi-character command line options. You will need to use -- instead.

For example -environment will no longer work, but --environment will. The single charater options will continue to work, for example -d and -c.

This greatly simplifies our command line argument parsing and makes it much easier to import the beats module into other projects.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Disruptive User Impact

If users have scripts that use the old single - arguments they will need to modify their scripts to use the double --.

Author's Checklist

  • [ ]

How to test this PR locally

  1. Build a beat
  2. make sure that -environment container fails but --environment container succeeds

Related issues

Use cases

Screenshots

Logs

@leehinman leehinman requested review from a team as code owners January 3, 2025 15:52
@leehinman leehinman requested review from rdner and faec January 3, 2025 15:52
@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Jan 3, 2025
Copy link
Contributor

mergify bot commented Jan 3, 2025

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @leehinman? 🙏.
For such, you'll need to label your PR with:

  • The upcoming major version of the Elastic Stack
  • The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-8./d is the label to automatically backport to the 8./d branch. /d is the digit

Copy link
Contributor

mergify bot commented Jan 3, 2025

backport-8.x has been added to help with the transition to the new branch 8.x.
If you don't need it please use backport-skip label and remove the backport-8.x label.

@mergify mergify bot added the backport-8.x Automated backport to the 8.x branch with mergify label Jan 3, 2025
@leehinman leehinman added the Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team label Jan 3, 2025
@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Jan 3, 2025
@elasticmachine
Copy link
Collaborator

Pinging @elastic/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane)

@leehinman leehinman added backport-skip Skip notification from the automated backport with mergify breaking change and removed backport-8.x Automated backport to the 8.x branch with mergify labels Jan 3, 2025
@leehinman leehinman force-pushed the 42117_remove_backwards_compat_for_flags branch from 341ef65 to 034a558 Compare January 3, 2025 16:23
- remove unused func
- remove unused var
@leehinman leehinman force-pushed the 42117_remove_backwards_compat_for_flags branch from 034a558 to ecd404f Compare January 3, 2025 16:47
Copy link
Member

@mauri870 mauri870 left a comment

Choose a reason for hiding this comment

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

I tested the beats locally as well as searching for all possible flags I could find in the help commands and subcommands of filebeat and metricbeat, couldn't find any leftover flags still using the single dash. LGTM.

@mauri870
Copy link
Member

mauri870 commented Jan 3, 2025

@leehinman I have a question about the fallout of this change. I understand that this is a breaking change but there are numerous Elastic repositories, documentation, and scripts that use the single dash in the commands. How should we address those that are not part of the Beats repository? Is there a plan for handling this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-skip Skip notification from the automated backport with mergify breaking change Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove backwards compatible flag support
3 participants