Skip to content

chore: promote develop to main#1128

Closed
GrammaTonic wants to merge 6 commits intomainfrom
develop
Closed

chore: promote develop to main#1128
GrammaTonic wants to merge 6 commits intomainfrom
develop

Conversation

@GrammaTonic
Copy link
Owner

Promote develop to main

Commits included

Merge strategy

Use regular merge (NOT squash) to preserve shared history between develop and main.

- PHASE2_IMPLEMENTATION_SUMMARY.md: fix relative paths to tests/integration/
  (./tests → ../../tests, resolves from docs/features/ correctly)
- PROMETHEUS_TIMELINE_VISUAL.md: replace absolute /plan/ path with relative
  ../../plan/ path
- prometheus-metrics-phase1.md: replace dead SUPPORT.md link with CONTRIBUTING.md
- PERFORMANCE_OPTIMIZATIONS.md: remove dead PARALLEL_NPM_RESULTS.md link
  (rejected feature, results file never created)
* fix: harden docs-validation and auto-sync-docs workflows

- Fix critical bug: super-linter FILTER_REGEX_INCLUDE/EXCLUDE used glob
  syntax instead of regex, linter was effectively scanning zero files.
  Changed to proper regex: (docs|wiki-content)/.* and docs/archive/.*
- Fix link-check silently swallowing failures: remove || true from
  markdown-link-check invocations so broken links actually fail the build
- Pin markdown-link-check to v3.14.2 to prevent supply chain attacks
- Add .markdown-link-check.json config with retry-on-429, timeout, and
  ignore patterns for flaky URLs (actions/runs, settings, wiki pages)
- Pin super-linter to SHA (12150456) instead of mutable v7 tag
- Add permissions block (contents: read, statuses: write) to
  docs-validation.yml to prevent overly broad default token scope
- Add concurrency group to cancel in-progress runs on rapid PR pushes
- Optimize checkout: fetch-depth 1 plus targeted base SHA fetch
- Fix patch diff: use PR base SHA instead of always diffing origin/main
- Integrate scripts/check-docs-structure.sh into CI pipeline
- Fix VALIDATE_MD to VALIDATE_MARKDOWN env var for super-linter v7
- Apply same fixes to auto-sync-docs.yml (identical copy-pasted bugs)

* fix: address Gemini review comments on link-check config

- Remove api.github.com from text/html header rule since the GitHub API
  serves JSON and would return errors with Accept: text/html
- Remove 301/302 from aliveStatusCodes since markdown-link-check follows
  redirects by default and including them could mask broken destinations
@gemini-code-assist
Copy link

Summary of Changes

Hello, 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 performs a routine promotion of the develop branch to main, integrating recent improvements and maintenance. The primary focus of the included changes is to bolster the robustness of documentation validation processes and to rectify existing broken links, thereby enhancing the overall quality and reliability of the project's documentation.

Highlights

  • Branch Promotion: The develop branch has been promoted to main, incorporating recent changes and fixes.
  • Documentation Validation Hardening: A new .markdown-link-check.json configuration file was added to enhance documentation validation workflows, including retry mechanisms, timeouts, and specific ignore patterns for GitHub URLs.
  • Broken Link Fixes: Several broken documentation links were repaired across various markdown files, ensuring accuracy and navigability within the project documentation.

🧠 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
  • .markdown-link-check.json
    • Added a new configuration file to enable robust markdown link checking, including settings for retries on 429 errors, timeouts, and specific ignore patterns for GitHub-related URLs.
  • docs/PERFORMANCE_OPTIMIZATIONS.md
    • Updated the 'Analysis' link for a rejected feature, replacing a file path with a descriptive text indicating results are not retained.
  • docs/features/PHASE2_IMPLEMENTATION_SUMMARY.md
    • Corrected relative paths for 'Testing Guide' and 'Integration Test' links to ensure proper navigation within the documentation.
  • docs/features/PROMETHEUS_TIMELINE_VISUAL.md
    • Adjusted the relative path for the 'Implementation Plan' link to correctly point to its location.
  • docs/features/prometheus-metrics-phase1.md
    • Updated a broken link in the 'For issues or questions' section, changing the reference from SUPPORT.md to CONTRIBUTING.md.
Ignored Files
  • Ignored by pattern: .github/workflows/** (2)
    • .github/workflows/auto-sync-docs.yml
    • .github/workflows/docs-validation.yml
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request promotes the develop branch to main, incorporating several documentation fixes and enhancements. A new configuration file for markdown-link-check is introduced to harden documentation validation, and multiple broken links across various markdown files have been corrected. My review focuses on the new configuration and the link fixes. I've identified a potential issue in the markdown-link-check configuration that could limit its effectiveness for GitHub links.

"timeout": "15s",
"httpHeaders": [
{
"urls": ["https://github.com"],

Choose a reason for hiding this comment

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

medium

The urls configuration for httpHeaders is set to ["https://github.com"]. According to the markdown-link-check documentation, this property expects an array of glob patterns. The current value will only match the exact URL https://github.com and not other pages on the domain, such as repository or issue pages. To apply the header to all URLs on github.com, you should use a glob pattern like https://github.com/**.

Suggested change
"urls": ["https://github.com"],
"urls": ["https://github.com/**"],

GrammaTonic added a commit that referenced this pull request Mar 1, 2026
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.
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.
Replace super-linter with markdownlint-cli2-action for ~95% faster Markdown linting. Add workflow_dispatch trigger for manual runs.
- Add continue-on-error to all validation steps so every check runs
- Capture output from structure, outdated refs, and link checks
- Generate GITHUB_STEP_SUMMARY with status table and per-check details
- Include 'How to fix' guidance for each failure type
- Final gate step fails the job if any check failed
Fix all validate-docs CI failures: auto-fix 656+ markdownlint errors, disable noisy rules, fix heading structure, repair dead links, strengthen link-check config. 0 errors across 46 files.
@GrammaTonic GrammaTonic closed this Mar 1, 2026
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.

1 participant