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.

Sign up for GitHub

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

Jump to bottom

test(linkcheck): ignore github md and rst link headers #4734

Merged
merged 1 commit into from
Jan 4, 2024
Merged

test(linkcheck): ignore github md and rst link headers #4734

merged 1 commit into from
Jan 4, 2024

Conversation

blackboxsw
Copy link
Collaborator

@blackboxsw blackboxsw commented Jan 4, 2024 •
edited
Loading

Proposed Commit Message

sphinx linkcheck cannot process link anchors in generated github
markdown or rst formatted pages. Ignore those expect failing links.

Also reduce expected github action linkcheck expected broken link count.

Additional Context

Should resolve linkcheck GH action failures seen in #4726

Test Steps

# note on main vs on this branch github md and rst link files from virt-manager and ubuntu-maintainers-handbook will no longer error as they are no longer checked.
tox -e linkcheck | grep broken

Checklist

Merge type

  • Squash merge using "Proposed Commit Message"
  • Rebase and merge unique commits. Requires commit messages per-commit each referencing the pull request number (#<PR_NUM>)

@blackboxsw blackboxsw force-pushed the linkcheck-ignore-github-md-rst-anchors branch from 1a8af49 to 53d7257 Compare January 4, 2024 06:01
blackboxsw added a commit to blackboxsw/cloud-init that referenced this pull request Jan 4, 2024
@blackboxsw
test(linkcheck): ignore github md and rst link headers (canonical#4734)
53d7257 
sphinx linkcheck cannot process link anchors in generated github
markdown or rst formatted pages. Ignore those expect failing links.

Also reduce expected github action linkcheck expected broken link
count.
@blackboxsw blackboxsw mentioned this pull request Jan 4, 2024
Merged
aciba90
aciba90 approved these changes Jan 4, 2024
View reviewed changes
Copy link
Contributor

@aciba90 aciba90 left a comment

Choose a reason for hiding this comment

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

LGTM.

@blackboxsw
test(linkcheck): ignore github md and rst link headers (canonical#4734)
610f6d6 
sphinx linkcheck cannot process link anchors in generated github
markdown or rst formatted pages. Ignore those expect failing links.

Also reduce expected github action linkcheck expected broken link
count.
@blackboxsw blackboxsw force-pushed the linkcheck-ignore-github-md-rst-anchors branch from 53d7257 to 610f6d6 Compare January 4, 2024 15:49
@blackboxsw blackboxsw merged commit 3673002 into canonical:main Jan 4, 2024
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aciba90 aciba90 aciba90 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@blackboxsw @aciba90