Question about broken-links.yml routine

[maxstridde]

Hi everybody,

Im new to this. I set up the al-folio website for myself and enjoy the ease of it. I did notice that in the broken-links.yml in .github/workflows the action is hardcoded to only run:

 # only run on the main repo
    if: github.repository == 'alshedivat/al-folio'

see here

Is this meant to be not used by users like me or should I change this to my own repo to use the action? Should this maybe be explained somewhere? I did see 4 other discussions about the broken-links.yml routine but they all seemed to be specific I have an error problems which is why this routine was disabled I believe? for example here

Im curios to learn, Hope somebody can enlighten me about this

Best wishes
Max

[george-gca]

You can read a little about it in our FAQ. But probably it is not that well explained.

Basically broken-links.yml check for broken links in only some of the files, more specifically:

al-folio/.github/workflows/broken-links.yml

Lines 26 to 39 in db2a1d1

	paths:
	- "assets/**"
	- "**.html"
	- "**.js"
	- "**.liquid"
	- "**/*.md"
	- "**.yml"
	- "!.github/workflows/axe.yml"
	- "!.github/workflows/deploy-docker-tag.yml"
	- "!.github/workflows/deploy-image.yml"
	- "!.github/workflows/docker-slim.yml"
	- "!.github/workflows/lighthouse-badger.yml"
	- "!.github/workflows/prettier.yml"
	- "!lighthouse_results/**"

But these files should not matter enough for our users that are creating their site. These are more for us to check if we are pointing somewhere in our docs and this link doesn't exist. The ignored files (starting with !) are those that might point somewhere else and it is not worth checking for the links (and to avoid too many requests).

For the users is more important that the built and deployed site have the correct links, and that's why the other action exists, it checks only for links inside the build _site/ directory.

[maxstridde]

thank you, sounds good to me :).