Conversation
…ition - Remove docs/TOOLS.md from git tracking (generated at build time) - Remove TOOLS.md generation from semantic-release exec/git plugins - Replace release:published trigger with workflow_run in docs.yml - Add build + generate steps before docs:build (TOOLS.md + inject-tool-refs) - Add inject-tool-refs.ts script for auto-syncing curated docs action tables - Add @Autogen:tool markers to curated docs (ci-cd, code-review, project-management, repository) - Fix TOOLS.md link in docs/tools/index.md (local /TOOLS instead of GitHub URL) - Add "Full API Reference" link to VitePress sidebar Closes #181
Test Coverage ReportOverall Coverage: 93.57%
|
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Pull request overview
This pull request addresses CI/CD infrastructure issues related to generated documentation artifacts and race conditions in the documentation deployment workflow.
Changes:
- Removes the auto-generated
docs/TOOLS.mdfrom git tracking, treating it as a build artifact generated only in CI - Fixes MCPB 404 race condition by replacing
release: [published]trigger withworkflow_runto ensure docs deploy waits for CI/CD Pipeline completion - Adds
inject-tool-refsscript to auto-sync curated documentation action tables from tool schemas via@autogen:toolmarkers
Reviewed changes
Copilot reviewed 10 out of 12 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
src/cli/inject-tool-refs.ts |
New script to inject action tables from schemas into markdown files with autogen markers |
package.json |
Adds inject-tool-refs script command pointing to compiled output |
docs/TOOLS.md |
Removed from git tracking (2901-line deletion) |
.gitignore |
Adds docs/TOOLS.md to ignore list |
.releaserc.json |
Removes TOOLS.md from git assets and prepareCmd generation |
.github/workflows/docs.yml |
Changes trigger to workflow_run, adds build and generation steps |
docs/tools/*.md |
Adds @Autogen:tool markers to 4 curated documentation files (15 markers total) |
docs/tools/index.md |
Fixes link from GitHub URL to local /TOOLS path |
docs/.vitepress/config.mts |
Adds "Full API Reference" sidebar entry |
- titleTemplate and transformHead() in VitePress config for per-page OG/Twitter meta - robots.txt with sitemap reference - title/description frontmatter on all 72 documentation pages
- Export extractActions, generateActionsTable, findMarkers, processFile - 45 tests covering oneOf/enum schemas, markers, file processing, main()
- Remove depth limit on project root discovery (traverse to FS root) - Simplify NODE_ENV guard (remove redundant undefined check) - Accept optional content param in processFile to avoid double reads - Escape pipe chars in action descriptions for valid markdown tables
…r OG urls - Escape backslash before pipe in generateActionsTable (CodeQL alert) - Use new URL() for robust og:url construction in transformHead
|
🎉 This PR is included in version 6.41.2 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/TOOLS.mdfrom git — now generated at build time in CI, no longer pollutes release commitsrelease: [published]trigger withworkflow_runso docs deploy waits for CI/CD Pipeline (incl. mcpb-bundle) to completeinject-tool-refsscript — auto-syncs curated docs action tables from tool schemas via<!-- @autogen:tool -->markersdocs/tools/index.mdnow links to local/TOOLSinstead of GitHub file URL/tools/sidebartitleTemplate,transformHead()for OG/Twitter,robots.txt, frontmatter on all 72 pagessrc/cli/inject-tool-refs.tsChanges
.gitignoredocs/TOOLS.md.releaserc.json.github/workflows/docs.ymlworkflow_runtrigger + build/generate stepssrc/cli/inject-tool-refs.tstests/unit/cli/inject-tool-refs.test.tspackage.jsoninject-tool-refsscriptdocs/.vitepress/config.mtsdocs/public/robots.txtdocs/tools/index.md/TOOLSdocs/tools/*.md@autogen:toolmarkers (4 files)docs/**/*.md(72 files)title+descriptionYAML frontmatterAuto-synced actions (previously missing from curated docs)
browse_filesdownload_attachmentmanage_work_itemadd_link,remove_linkSEO improvements
<title>viatitleTemplate: "%s | GitLab MCP"transformHead()generatesog:title,og:description,og:url,twitter:card,twitter:title,twitter:descriptiontitle+descriptionfrontmatter (max 160 chars)robots.txtallows all crawlers + references sitemap.xmlsitemap.xmlauto-generated by VitePress with hostnameTest plan
yarn lint— 0 errorsyarn test— 3878 tests pass (including 45 new inject-tool-refs tests)yarn build— compiles successfullyyarn docs:build— generates docs with sitemap, validates all frontmatteryarn inject-tool-refs— updates 4 files, 15 markersinject-tool-refs— 0 updates (idempotent)workflow_runtriggers docs deploy after CI/CD completes/downloads/gitlab-mcp-latest.mcpbreturns 200Closes #181