Skip to content
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

Merged
merged 1 commit into from
Feb 17, 2023

Conversation

edsantiago
Copy link
Member

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]

Fix broken man pages

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Feb 17, 2023

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 17, 2023
@edsantiago edsantiago requested a review from mheon February 17, 2023 01:24
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]>
Copy link
Member

@Luap99 Luap99 left a 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.

@edsantiago
Copy link
Member Author

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.

@Luap99
Copy link
Member

Luap99 commented Feb 17, 2023

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.

@ashley-cui
Copy link
Member

/lgtm

/cherry-pick v4.4

@openshift-cherrypick-robot
Copy link
Collaborator

@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:

/lgtm

/cherry-pick v4.4

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.

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Feb 17, 2023
@openshift-merge-robot openshift-merge-robot merged commit 445f72d into containers:main Feb 17, 2023
@openshift-cherrypick-robot
Copy link
Collaborator

@ashley-cui: new pull request created: #17552

In response to this:

/lgtm

/cherry-pick v4.4

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.

@edsantiago edsantiago deleted the emergency_man_fix branch February 17, 2023 20:41
@github-actions github-actions bot added the locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. label Sep 9, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 9, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. release-note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants