-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
Emergency fix for man pages: check for broken includes #17544
Emergency fix for man pages: check for broken includes #17544
Conversation
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: edsantiago 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 |
Somehow the options/secret.md file generated corrupt md which then generated corrupt .man files. Fix, and add a Makefile check to prevent this from happening again. Signed-off-by: Ed Santiago <[email protected]>
b49d24e
to
9622d25
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, maybe we should add a markdown linter to spot these in CI.
I tried! See commented-out Makefile stuff. It failed in the "build every commit" step, quite probably because I added the check in the wrong place. (It's running after one md2man, not after all of them are done). It was late last night and I needed an emergency fix. |
This is not what I meant, I argue we need an actual linter that checks that the markdown is valid. Your import mechanism causes it to skip things but if the markdown malformed the generated man page is likely unreadable regardless of import or not. |
/lgtm /cherry-pick v4.4 |
@ashley-cui: once the present PR merges, I will cherry-pick it on top of v4.4 in a new PR and assign it to you. In response to this:
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/test-infra repository. |
@ashley-cui: new pull request created: #17552 In response to this:
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/test-infra repository. |
Somehow the options/secret.md file generated corrupt md which
then generated corrupt .man files. Fix, and add a Makefile
check to prevent this from happening again.
Signed-off-by: Ed Santiago [email protected]