Skip to content

Encode history-link query quotes to prevent footer markdown link breakage #53978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 9 commits into from
Aug 20, 2026
+32 −2
Merged

Encode history-link query quotes to prevent footer markdown link breakage #53978

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
1e1332c
Initial plan
Copilot Aug 19, 2026
89d1d05
Fix markdown-safe encoding for related-runs history URLs
Copilot Aug 19, 2026
f3c8ec5
Address review feedback in history URL encoding fix
Copilot Aug 19, 2026
0c1e1ca
Encode RFC3986 chars in history query and add paren regression test
Copilot Aug 19, 2026
5b79f6c
Merge remote-tracking branch 'origin/main' into copilot/fix-footer-re…
Copilot Aug 19, 2026
9da10e7
chore: start follow-up for merge main and js lint
Copilot Aug 20, 2026
981c30c
Merge remote-tracking branch 'refs/remotes/origin/main' into copilot/…
Copilot Aug 20, 2026
c55026b
test: strengthen quote-encoding regression assertion
Copilot Aug 20, 2026
def27e2
Merge branch 'main' into copilot/fix-footer-related-runs-link
github-actions[bot] Aug 20, 2026
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
8 changes: 6 additions & 2 deletions actions/setup/js/generate_history_link.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,15 @@ function generateHistoryUrl({ owner, repo, itemType, workflowCallId, workflowId,
throw new Error(`Invalid server URL: ${server}`);
}
})();
url.searchParams.set("q", queryParts.join(" "));
const encodedQuery = encodeURIComponent(queryParts.join(" "))
.replace(/[!'()*]/g, char => `%${char.charCodeAt(0).toString(16).toUpperCase()}`)
.replaceAll("%20", "+");

// Set the type parameter based on itemType for correct GitHub search filtering
const searchTypeMap = { issue: "issues", pull_request: "pullrequests", discussion: "discussions", comment: "issues", discussion_comment: "discussions" };
url.searchParams.set("type", searchTypeMap[itemType] ?? "issues");
const searchType = searchTypeMap[itemType] ?? "issues";

url.search = `q=${encodedQuery}&type=${searchType}`;

return url.toString();
}
Expand Down
26 changes: 26 additions & 0 deletions actions/setup/js/generate_history_link.test.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,32 @@ describe("generate_history_link.cjs", () => {
expect(url).toContain("gh-aw-workflow-call-id%3A+caller%2Frepo%2FWorkflowName");
});

it("should percent-encode both marker delimiter quotes for markdown-safe links", () => {
const url = generateHistoryUrl({
owner: "elastic",
repo: "docs-eng-team",
itemType: "issue",
workflowCallId: "elastic/docs-eng-team/gh-aw-issue-auto-triage",
serverUrl: "https://github.com",
});

@github-actions github-actions Bot Aug 19, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[/tdd] The negative assertion only guards against one specific raw-quote pattern; if the query structure changes, a raw " could sneak back in undetected.

💡 Stronger guard

Replace the narrow not.toContain with a blanket assertion that no unencoded quote survives:

expect(url).not.toContain('"');

This directly enforces the invariant the fix is meant to provide, regardless of where in the query a raw quote might appear.

@copilot please address this.

Copilot AI Aug 20, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Implemented in c55026b: strengthened the test to assert expect(url).not.toContain('"'), so any raw quote in the generated URL now fails the test.


expect(url).toContain("%22gh-aw-workflow-call-id%3A+elastic%2Fdocs-eng-team%2Fgh-aw-issue-auto-triage%22");
expect(url).not.toContain('"');
});

it("should percent-encode marker parentheses to preserve markdown-safe link targets", () => {
const url = generateHistoryUrl({
owner: "elastic",
repo: "docs-eng-team",
itemType: "issue",
workflowId: "triage(workflow)",
serverUrl: "https://github.com",
});

expect(url).toContain("gh-aw-workflow-id%3A+triage%28workflow%29");
expect(url).not.toContain("triage(workflow)");
});

it("should include workflow-id marker in search query when used", () => {
const url = generateHistoryUrl({
owner: "testowner",
Expand Down
Loading