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

Add CI for checking for broken links manually, weekly and in PRs #1633

Open
wants to merge 83 commits into
base: main
Choose a base branch
from

Conversation

markcmiller86
Copy link
Member

@markcmiller86 markcmiller86 commented Apr 18, 2023

Resolves: #1431

Links will get checked automatically weekly at 5:17 AM on Sundays. They can also be checked manually by just running the workflow.

We need to adjust the filters used in the checker and there are a lot of broken links found (see #1632)

  • Set list of Reviewers (at least one).
  • Add to Project BSSw Internal.
  • [ ] View the modified *.md files as rendered in GitHub.
  • [ ] If changes are to the GitHub pages site under the docs/ directory, consider viewing locally with Jekyll.
  • Watch for PR check failures.
  • Make any final changes to the PR based on feedback and review GitHub (and Jekyll) rendered files.
  • Ensure at least one reviewer signs off on the changes.
  • Once reviewer has approved and PR check pass, then merge the PR.

@markcmiller86 markcmiller86 changed the title Create check-published-links-weekly.yml Add CI for checking for broken links weekly (and manually) Apr 18, 2023
@bartlettroscoe
Copy link
Member

@markcmiller86, please @mention me and let me know when this is ready to review

@markcmiller86 markcmiller86 marked this pull request as draft April 18, 2023 21:50
@markcmiller86
Copy link
Member Author

Apologies...I converted to DRAFT for time being.

@markcmiller86
Copy link
Member Author

Have adjusted it to ignore...

  • docs -- those links are often not really public...EB should fix but we can do as encountered.
  • Events -- short lived and links are likely to stale over time

@markcmiller86
Copy link
Member Author

Ok, this addresses all the cases in #1632.

I am pulling out of DRAFT mode. Its ready for review.

@markcmiller86 markcmiller86 marked this pull request as ready for review April 19, 2023 00:00
@markcmiller86
Copy link
Member Author

@rinkug, @bartlettroscoe and @bernhold this is now ready for review.

The weekly CI check should result in a small list of either bonified broken links or false negatives (e.g. says its broken when its not) to try to check and then either go edit files to fix, add to ignore patterns or just ignore.

@vsoch
Copy link
Contributor

vsoch commented Jun 29, 2024

I'm going to unsubscribe from notifications here - good luck @markcmiller86 !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Periodic CI to find links that have gone bad
5 participants