Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/daily-doc-healer.lock.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions .github/workflows/daily-doc-updater.lock.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions .github/workflows/dev.lock.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 1 addition & 3 deletions .github/workflows/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,7 @@ tools:
gpu: true
checkouts:
- name: docs
paths:
- docs/src/**/*.md
- docs/src/**/*.mdx
pattern: "docs/src/**"
Copy link
Contributor

Choose a reason for hiding this comment

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

@copilot docs/src/**/.md

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated to "docs/src/**/*.md" in 1f3b240.

context: "gh-aw project documentation"
searches:
- name: issues
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/developer-docs-consolidator.lock.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions .github/workflows/dictation-prompt.lock.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions .github/workflows/glossary-maintainer.lock.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 1 addition & 4 deletions .github/workflows/shared/mcp/qmd-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,7 @@ tools:
gpu: true
checkouts:
- name: gh-aw
paths:
- docs/src/content/docs/**
- .github/agents/**
- .github/aw/**
pattern: "**"
Copy link
Contributor

Choose a reason for hiding this comment

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

docs/**/.md @copilot

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated to "docs/**/*.md" in 1f3b240.

context: "gh-aw project documentation, agent definitions, and workflow authoring instructions"

---
Expand Down
5 changes: 1 addition & 4 deletions .github/workflows/shared/mcp/qmd.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,7 @@ tools:
gpu: true
checkouts:
- name: gh-aw
paths:
- docs/src/content/docs/**
- .github/agents/**
- .github/aw/**
pattern: "**"
Copy link
Contributor

Choose a reason for hiding this comment

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

See other comments

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated to "docs/**/*.md" in 1f3b240.

context: "gh-aw project documentation, agent definitions, and workflow authoring instructions"

---
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/smoke-codex.lock.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 1 addition & 3 deletions .github/workflows/smoke-codex.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,7 @@ tools:
qmd:
checkouts:
- name: docs
paths:
- docs/src/**/*.md
- docs/src/**/*.mdx
pattern: "docs/src/**"
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

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

pattern: "docs/src/**" is much broader than the previous docs/src/**/*.md + docs/src/**/*.mdx and will also match non-documentation files (assets, scripts, styles, etc.), potentially bloating the index or causing binary/text parsing issues. Consider narrowing the pattern to the docs content directory and/or using ignore to exclude non-doc paths.

Suggested change
pattern: "docs/src/**"
pattern: "docs/src/**/*.{md,mdx}"

Copilot uses AI. Check for mistakes.
context: "gh-aw project documentation"
searches:
- name: issues
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/technical-doc-writer.lock.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions .github/workflows/unbloat-docs.lock.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions .github/workflows/weekly-blog-post-writer.lock.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 6 additions & 8 deletions actions/setup/js/qmd_index.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ const { pathToFileURL } = require("url");
const { ERR_CONFIG, ERR_VALIDATION } = require("./error_codes.cjs");

/**
* @typedef {{ name: string, path: string, patterns?: string[], context?: string }} QmdCheckout
* @typedef {{ name: string, path: string, pattern?: string, context?: string }} QmdCheckout
* @typedef {{ name?: string, type?: string, query?: string, repo?: string, min?: number, max?: number, tokenEnvVar?: string }} QmdSearch
* @typedef {{ dbPath: string, checkouts?: QmdCheckout[], searches?: QmdSearch[] }} QmdConfig
*/
Expand Down Expand Up @@ -48,12 +48,12 @@ async function writeSummary(config, updateResult, embedResult) {
const checkouts = config.checkouts ?? [];
if (checkouts.length > 0) {
md += "### Collections\n\n";
md += "| Name | Patterns | Context |\n";
md += "| Name | Pattern | Context |\n";
md += "| --- | --- | --- |\n";
for (const col of checkouts) {
const patterns = (col.patterns || ["**/*.md"]).join(", ");
const pattern = col.pattern || "**/*.md";
const ctx = col.context || "-";
md += `| ${col.name} | ${patterns} | ${ctx} |\n`;
md += `| ${col.name} | ${pattern} | ${ctx} |\n`;
}
md += "\n";
}
Expand Down Expand Up @@ -138,8 +138,7 @@ async function main() {
for (const checkout of config.checkouts || []) {
const rawPath = checkout.path;
const resolvedPath = resolveEnvVars(rawPath);
const patterns = checkout.patterns || ["**/*.md"];
const pattern = patterns.join(",");
const pattern = checkout.pattern || "**/*.md";

core.info(`Collection "${checkout.name}": path="${rawPath}" -> "${resolvedPath}" pattern="${pattern}"`);

Expand Down Expand Up @@ -274,8 +273,7 @@ async function main() {
core.warning(
"No files were indexed. Possible causes:\n" +
" - The checkout path does not exist or was not checked out\n" +
" - The glob patterns do not match any files (check for dotfile exclusions in patterns starting with '.')\n" +
" - The pattern uses a comma-separated list that the qmd SDK does not support\n" +
" - The glob pattern does not match any files (check for dotfile exclusions in patterns starting with '.')\n" +
" - The checkout path resolves to an empty string (check ${ENV_VAR} placeholders in 'path')\n" +
"Review the collection log lines above for the resolved path and pattern."
);
Expand Down
10 changes: 5 additions & 5 deletions actions/setup/js/qmd_index.test.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ describe("qmd_index.cjs", () => {

await runMain({
dbPath: path.join(tmpDir, "index"),
checkouts: [{ name: "docs", path: docsDir, patterns: ["**/*.md"], context: "Project docs" }],
checkouts: [{ name: "docs", path: docsDir, pattern: "**/*.md", context: "Project docs" }],
});

expect(mockCore.setFailed).not.toHaveBeenCalled();
Expand All @@ -199,7 +199,7 @@ describe("qmd_index.cjs", () => {

await runMain({
dbPath: path.join(tmpDir, "index"),
checkouts: [{ name: "docs", path: "${GITHUB_WORKSPACE}", patterns: ["**/*.md"] }],
checkouts: [{ name: "docs", path: "${GITHUB_WORKSPACE}", pattern: "**/*.md" }],
});

expect(mockCore.setFailed).not.toHaveBeenCalled();
Expand Down Expand Up @@ -393,7 +393,7 @@ describe("qmd_index.cjs", () => {

await runMain({
dbPath: path.join(tmpDir, "index"),
checkouts: [{ name: "docs", path: docsDir, patterns: ["**/*.md"] }],
checkouts: [{ name: "docs", path: docsDir, pattern: "**/*.md" }],
searches: [{ name: "issues", type: "issues", max: 50 }],
});

Expand Down Expand Up @@ -426,15 +426,15 @@ describe("qmd_index.cjs", () => {

await runMain({
dbPath: path.join(tmpDir, "index"),
checkouts: [{ name: "docs", path: docsDir, patterns: ["**/*.md", "**/*.mdx"], context: "Project docs" }],
checkouts: [{ name: "docs", path: docsDir, pattern: "**/*.md", context: "Project docs" }],
});

const summaryText = mockCore.summary.addRaw.mock.calls.flat().join("\n");
expect(summaryText).toContain("<details open>");
expect(summaryText).toContain("<summary>qmd documentation index</summary>");
expect(summaryText).toContain("</details>");
expect(summaryText).toContain("### Collections");
expect(summaryText).toContain("| docs | **/*.md, **/*.mdx | Project docs |");
expect(summaryText).toContain("| docs | **/*.md | Project docs |");
expect(mockCore.summary.write).toHaveBeenCalledOnce();
});

Expand Down
Loading
Loading