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

docs: Add all md files in root dir to linkchecker #1461

Closed
wants to merge 11 commits into from
Closed

docs: Add all md files in root dir to linkchecker #1461

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
54a9aae
Add all md files in root dir to linkchecker
p-offtermatt Nov 30, 2023
fd15223
Add whole repo to linkchecker
p-offtermatt Nov 30, 2023
556b1db
Fix links
p-offtermatt Nov 30, 2023
b54981e
Fix link: into -> intro
p-offtermatt Nov 30, 2023
00448e0
Remove excluded folders in the linkchecker workflow
p-offtermatt Dec 1, 2023
c4d05a5
Revert changes to .changelog folder
p-offtermatt Dec 1, 2023
c4ed126
Ignore links to .changelog directory and utilize config file
p-offtermatt Dec 1, 2023
6c1b3be
Check repo root and docs/docs separately
p-offtermatt Dec 1, 2023
9ab806c
Change job names
p-offtermatt Dec 1, 2023
fd6a90c
Merge branch 'main' into ph/linkchecker
p-offtermatt Dec 5, 2023
96ed736
Add back trigger condition for link checker
p-offtermatt Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/workflows/linkchecker.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,12 @@ jobs:
# Check out the latest version of the code
- uses: actions/checkout@v4

# Remove folders that we do not want to check.
# This is due to the markdown-link-check action
# not having an exclude parameter, see
# https://github.com/gaurav-nelson/github-action-markdown-link-check/issues/38
- name: Remove folders that we do not want to check
Copy link
Contributor

Choose a reason for hiding this comment

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

Isn't this going to just remove an entire folder from the repo? See #1464 as a potential solution.

Copy link
Contributor Author

@p-offtermatt p-offtermatt Dec 1, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

It will remove it, but only in the context of this workflow - maybe I'm wrong, but your PR just changes the trigger for the workflow not to trigger on changes to .changelog, but the check still considers files in the .changelog folder when it triggers, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In this PR, note the folder is only removed for this particular workflow, so it doesn't negatively impact other workflows

run: rm -rf .changelog

# Checks the status of hyperlinks in *.md files in docs/
- uses: gaurav-nelson/[email protected]
Loading