Exclude certain URLs for local linkchecks #109
Conversation
- branched github URLs being checked even though they don't exist until pushed. Those URLs are now optionally checked with the -r flag - "linkcheck" -> "lychee" to distinguish the function that runs lychee linkchecks and the function that runs doclinkchecker linkchecks
|
I was looking at the gh actions - afaik this doesn't affect them because the docfx-utils.ps1 script is never being run with the |
|
I already had forgotten that we decoupled the lychee action remotely; it probably isn't worth adding a flag to the utility script, because it won't affect the actions since we are using a totally different system. I would remove the $remote flag, and just exclude the link everytime it's run locally. The other changes are valid and we should leave the renaming as it is. I guess we don't even need to update the README, since the only thing that's being changed is the internal call and not the alias, so that's easy. |
|
Why did we decouple it again? Is it for the |
|
It's decoupled because there is a Github action already packaged for lychee. If we didn't use the action, we would need to download and install the lychee executable in the Github environment for every run, which seemed like more trouble than it was worth to utilize the utility script. We can definitely revisit this issue though and see if it is worth the effort |
|
Nah. I think that's the way to go for now. I think a "wish list" issue will be doing something similar locally so we don't have to specify the lychee location when calling In the meanwhile, I think the best solution is as you suggested which is to remove the |
|
Approved, but leaving this open in case we want to revisit and update anything before merging |
|
I don't think I'll have any updates. I already made the "wish list" issue (#114) described in my last comment. If you have any reservations or changes you'd like to make, feel to address them. Otherwise, go ahead and merge. |
Resolve #74