🌱 add generated CLI usage to the README#1943
Closed
guettli wants to merge 7 commits into
Closed
Conversation
github-actions
Bot
added
size/M
Dhairya-Arora01
approved these changes
Apr 22, 2026
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
Contributor
There was a problem hiding this comment.
Would be better, if we add a brief introduction for the script.
Contributor
|
do we really wanna have this printed in the readme? We will for sure forget about it and then it's outdated. |
Collaborator
Author
The part in the README gets updated by a script, and in CI there is a check which ensures that is up-to-date. But this is not important. First v1.1.x merge. This PR can be done later. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Generate the README usage block from the main binary via
hack/update-readme-usage.shTo make this work some parts needed to be changed, so that showing the usage without connection to a cluster works.