Skip to content

Fix print command instructions in README #218

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

Merged
merged 1 commit into from
Apr 19, 2025

Conversation

spencerhance
Copy link
Contributor

@spencerhance spencerhance commented Apr 18, 2025

What type of PR is this?
/kind documentation

What this PR does / why we need it:

Fixes the example print command in the README, which currently will print this:

./ingress2gateway print
Error: required flag(s) "providers" not set
Usage:
  ingress2gateway print [flags]
...
  • v0.3.0 made the --providers print command required, however the README wasn't updated
  • Updates the example print command to use --providers=ingress-nginx since at least one provider must be specified
  • Removes the default option of providers in the table in the README since it no longer exists.

Does this PR introduce a user-facing change?:

NONE

* v0.3.0 made the `--providers` print command required, however the README wasn't updated
* Updates the example print command to use --providers=ingress-nginx since at least one provider *must* be specified
* Removes the default option of providers in the table in the README since it no longer exists.
@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Apr 18, 2025
@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Apr 18, 2025
@spencerhance
Copy link
Contributor Author

/assign @robscott

@robscott
Copy link
Member

Thanks @spencerhance!

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 18, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: robscott, spencerhance

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:

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 18, 2025
@k8s-ci-robot k8s-ci-robot merged commit 9219873 into kubernetes-sigs:main Apr 19, 2025
5 checks passed
@spencerhance spencerhance deleted the providers-required branch April 19, 2025 00:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants