updating the script to handle multi-line flag descriptions

[aman4433]

What type of PR is this?

What this PR does / why we need it:

This PR enhances the generate-flags.sh script to handle flags with multi-line descriptions, specifically to address the case of --feature-gates.

Previously, such flags were either incorrectly parsed or excluded from the generated flags.md documentation due to their multi-line nature. This led to incomplete CLI documentation, which can cause confusion for users, especially when dealing with important features like in-place updates that are behind feature gates.

With this update the script now properly captures and formats multi-line flag descriptions.

This ensures that all flags—including complex ones like --feature-gates—are accurately represented in the VPA component documentation.

Which issue(s) this PR fixes:

Fixes #8139

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

[k8s-ci-robot]

Welcome @aman4433!

It looks like this is your first PR to kubernetes/autoscaler 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/autoscaler has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @aman4433. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[omerap12]

/ok-to-test

[omerap12]

Thanks for this, but I see some errors:

Building updater...
Generating flags documentation...
awk: cmd. line:6:         default = ""
awk: cmd. line:6:         ^ syntax error
awk: cmd. line:6:         default = ""
awk: cmd. line:6:         ^ syntax error
awk: cmd. line:6:         default = ""
awk: cmd. line:6:         ^ syntax error

[aman4433]

Thanks for this, but I see some errors:

Building updater...
Generating flags documentation...
awk: cmd. line:6:         default = ""
awk: cmd. line:6:         ^ syntax error
awk: cmd. line:6:         default = ""
awk: cmd. line:6:         ^ syntax error
awk: cmd. line:6:         default = ""
awk: cmd. line:6:         ^ syntax error

It's fixed now!

[omerap12]

looks very good to me.
Thanks @aman4433
/assign @adrianmoisey

[omerap12]

/lgtm

[adrianmoisey]

/approve
/hold

We just want to get another older PR into master before this PR lands.
Once that PR is in, this one will need to be rebased with those changes, sorry about that!

[aman4433]

Sure @adrianmoisey, just let me know once the older PR is in, and I'll go ahead and rebase this one with those changes!

[omerap12]

Sure @adrianmoisey, just let me know once the older PR is in, and I'll go ahead and rebase this one with those changes!

With this 7992 merged can you please rebase and re-run the flag generation script?

[omerap12]

This is a flake, can you make another empty commit just to trigger the tests again?

[omerap12]

Great work @aman4433 , thanks!
/lgtm
/approve
/unhold

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: adrianmoisey, aman4433, omerap12

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• vertical-pod-autoscaler/OWNERS [adrianmoisey,omerap12]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[aman4433]

Thanks! Looking forward to more contributions.