fix: add link-check ignore patterns for localhost and private URLs#1129
fix: add link-check ignore patterns for localhost and private URLs#1129GrammaTonic merged 1 commit intodevelopfrom
Conversation
Add ignore patterns for localhost URLs (documentation examples not reachable in CI) and GitHub user project board URLs (private/404 in CI). Fixes docs-validation failure on PR #1128.
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the documentation link validation process by introducing new ignore patterns. It addresses CI failures caused by unreachable Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds ignore patterns to the markdown link checker configuration to avoid failures on localhost and private GitHub project URLs, which are unreachable in CI. The change is correct and addresses the issue. I've suggested a minor improvement to make the localhost pattern more robust to cover more edge cases.
| "pattern": "^https://github\\.com/users/.*/projects/" | ||
| }, | ||
| { | ||
| "pattern": "^https?://localhost[:/]" |
There was a problem hiding this comment.
The regular expression ^https?://localhost[:/] is a bit restrictive. It will not match a URL that is just http://localhost without a trailing port or path. Using a word boundary (\b) would make this pattern more robust, correctly matching localhost as a whole word in various URL formats (e.g., with a port, with a path, or standalone) while avoiding matches for hostnames that merely start with localhost.
| "pattern": "^https?://localhost[:/]" | |
| "pattern": "^https?://localhost\\b" |
1 participant
Adds ignore patterns to
.markdown-link-check.jsonfor:http(s)://localhostURLs (documentation examples, unreachable in CI)https://github.com/users/*/projects/URLs (private project boards, return 404 in CI)Fixes the docs-validation failure on PR #1128 (develop to main promotion).