operator-sdk
operator-sdk copied to clipboard
operator-framework
CLI docs generation is not working well with flags deprecated
Bug Report
If we mark a command flag as deprecated the logic to generate the docs (https://github.com/operator-framework/operator-sdk/blob/master/Makefile#L42) is not adding the flag on the docs.
E.g crd-versions and webhook-versions which were flagged as deprecated
What did you do?
mark flags as deprecated and re-gen the docs
What did you expect to see?
the docs are generated with the flags deprecated and if possible with the info that they are deprecated.
What did you see instead? Under which circumstances?
the flags removed from the docs
I was in the assumption that this is intentional, so that users do not use it. But I see the use case here. Nevertheless, we generate the docs from the help text generated by cobra command. There was an issue for this raised with spf13/cobra (https://github.com/spf13/cobra/issues/358), looks like it is still open and there is discussion going on whether to have deprecated flags shown in help message or not.
Issues go stale after 90d of inactivity.
Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.
If this issue is safe to close now please do so with /close.
/lifecycle stale
