Skip to content

🌱 add generated CLI usage to the README#1943

Open
guettli wants to merge 7 commits intov1.1.xfrom
tg/show-usage-in-readme
Open

🌱 add generated CLI usage to the README#1943
guettli wants to merge 7 commits intov1.1.xfrom
tg/show-usage-in-readme

Conversation

@guettli
Copy link
Copy Markdown
Collaborator

@guettli guettli commented Apr 10, 2026

Generate the README usage block from the main binary via hack/update-readme-usage.sh

To make this work some parts needed to be changed, so that showing the usage without connection to a cluster works.

@github-actions github-actions Bot added size/M Denotes a PR that changes 50-200 lines, ignoring generated files. area/hack Changes made in the hack directory labels Apr 10, 2026
@guettli guettli marked this pull request as ready for review April 10, 2026 11:14
@guettli guettli requested a review from Dhairya-Arora01 April 10, 2026 11:15
# 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Would be better, if we add a brief introduction for the script.

Copy link
Copy Markdown
Contributor

@janiskemper janiskemper left a comment

Choose a reason for hiding this comment

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

it's outdated

@janiskemper
Copy link
Copy Markdown
Contributor

do we really wanna have this printed in the readme? We will for sure forget about it and then it's outdated.

@guettli
Copy link
Copy Markdown
Collaborator Author

guettli commented Apr 22, 2026

@janiskemper

do we really wanna have this printed in the readme? We will for sure forget about it and then it's outdated.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/hack Changes made in the hack directory size/M Denotes a PR that changes 50-200 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants