@e2edev/github 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 TesterArmy, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,32 @@
+# @e2edev/github
+
+The GitHub reporter for [`@e2edev/e2e`](https://www.npmjs.com/package/@e2edev/e2e).
+From GitHub Actions, every run becomes one pull request comment, edited in
+place on reruns, and the same text lands in the job summary.
+
+```bash
+npm install --save-dev @e2edev/github
+```
+
+```ts title="e2e.config.ts"
+import type { E2EConfig } from '@e2edev/e2e';
+import { playwright } from '@e2edev/playwright';
+import { github } from '@e2edev/github';
+
+export default {
+  targets: [{ engine: playwright({ url: 'http://localhost:3000' }) }],
+  reporters: ['list', github()],
+} satisfies E2EConfig;
+```
+
+The job needs `permissions: pull-requests: write` and the step that runs
+`e2e` needs `GITHUB_TOKEN: ${{ github.token }}` in its `env`. Matrix replicas
+of one job pass a `key` so their comments stay apart. When the reporter cannot
+post (another CI, a push, a fork's read-only token) it says why in one summary
+row and never changes the run's exit code.
+
+Full documentation lives at [e2e-docs.vercel.app/github](https://e2e-docs.vercel.app/github).
+
+## License
+
+MIT

package/dist/actions.d.ts

@@ -0,0 +1,47 @@
+/**
+ * What GitHub Actions tells a job about itself, read from the environment
+ * the runner sets: the repository, the pull request the job runs for, the
+ * commit to link sources at, the token, and where the job summary is written.
+ *
+ * The pull request number comes from the event payload first, since
+ * `pull_request`, `pull_request_target`, and a PR's `issue_comment` all carry
+ * it there, and from `GITHUB_REF` (`refs/pull/N/merge`) when the payload has
+ * none. Nothing here is read until the run has finished.
+ */
+export interface ActionsContext {
+    /** `owner/repo`. */
+    readonly repository: string;
+    /** `https://github.com`, or the GitHub Enterprise Server host. */
+    readonly serverUrl: string;
+    /** `https://api.github.com`, or the Enterprise Server API root. */
+    readonly apiUrl: string;
+    /** The workflow run page, where uploaded artifacts live. */
+    readonly runUrl: string;
+    readonly eventName: string;
+    readonly workflow: string;
+    readonly job: string;
+    /**
+     * The commit sources are linked at: the pull request's head when the event
+     * payload names it, the checked-out SHA when the event is not about a pull
+     * request, and nothing on an `issue_comment`, whose SHA is the default
+     * branch and would link every source line to the wrong revision.
+     */
+    readonly sha: string | undefined;
+    readonly pullRequest: number | undefined;
+    /** `GITHUB_TOKEN`, or `GH_TOKEN` the way the `gh` CLI reads it. */
+    readonly token: string | undefined;
+    /** The file `GITHUB_STEP_SUMMARY` names, when the runner provides one. */
+    readonly stepSummaryPath: string | undefined;
+}
+export interface ActionsDeps {
+    readonly env: NodeJS.ProcessEnv;
+    readonly readFile: (file: string) => Promise<string>;
+}
+/**
+ * The Actions context of the current job, or undefined outside GitHub
+ * Actions. On Actions the runner always sets the repository, run id, event
+ * name, workflow, and job; a job missing one is broken, not "not Actions",
+ * and says so.
+ */
+export declare function detectActions(deps: ActionsDeps): Promise<ActionsContext | undefined>;
+//# sourceMappingURL=actions.d.ts.map

package/dist/actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../src/actions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAIH,MAAM,WAAW,cAAc;IAC7B,oBAAoB;IACpB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,kEAAkE;IAClE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,mEAAmE;IACnE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,4DAA4D;IAC5D,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC,mEAAmE;IACnE,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,0EAA0E;IAC1E,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9C;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,UAAU,CAAC;IAChC,QAAQ,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CACtD;AAsDD;;;;;GAKG;AACH,wBAAsB,aAAa,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CA0B1F"}

package/dist/actions.js

@@ -0,0 +1,90 @@
+/**
+ * What GitHub Actions tells a job about itself, read from the environment
+ * the runner sets: the repository, the pull request the job runs for, the
+ * commit to link sources at, the token, and where the job summary is written.
+ *
+ * The pull request number comes from the event payload first, since
+ * `pull_request`, `pull_request_target`, and a PR's `issue_comment` all carry
+ * it there, and from `GITHUB_REF` (`refs/pull/N/merge`) when the payload has
+ * none. Nothing here is read until the run has finished.
+ */
+import { isRecord } from './json.js';
+/** A variable's trimmed value; unset and blank both read as undefined. */
+function envValue(env, name) {
+    const raw = env[name];
+    return raw === undefined || raw.trim() === '' ? undefined : raw.trim();
+}
+function pullRequestNumber(value) {
+    return typeof value === 'number' && Number.isInteger(value) && value > 0 ? value : undefined;
+}
+/**
+ * Reads the pull request out of the webhook payload, or nothing when the
+ * payload is missing, unreadable, or not about a pull request.
+ */
+async function readEvent(path, deps) {
+    if (path === undefined)
+        return undefined;
+    let payload;
+    try {
+        payload = JSON.parse(await deps.readFile(path));
+    }
+    catch {
+        return undefined;
+    }
+    if (!isRecord(payload))
+        return undefined;
+    const pull = payload['pull_request'];
+    if (isRecord(pull)) {
+        const head = pull['head'];
+        return {
+            number: pullRequestNumber(pull['number']),
+            headSha: isRecord(head) && typeof head['sha'] === 'string' ? head['sha'] : undefined,
+        };
+    }
+    // An `issue_comment` on a pull request: the issue carries a `pull_request`
+    // link but not the head commit, and GITHUB_SHA is the default branch here.
+    const issue = payload['issue'];
+    if (isRecord(issue) && isRecord(issue['pull_request'])) {
+        return { number: pullRequestNumber(issue['number']), headSha: undefined };
+    }
+    return undefined;
+}
+/** The number in `refs/pull/N/merge` or `refs/pull/N/head`. */
+function pullFromRef(ref) {
+    const match = ref === undefined ? null : /^refs\/pull\/(\d+)\//.exec(ref);
+    return match === null ? undefined : pullRequestNumber(Number(match[1]));
+}
+/**
+ * The Actions context of the current job, or undefined outside GitHub
+ * Actions. On Actions the runner always sets the repository, run id, event
+ * name, workflow, and job; a job missing one is broken, not "not Actions",
+ * and says so.
+ */
+export async function detectActions(deps) {
+    const value = (name) => envValue(deps.env, name);
+    if (value('GITHUB_ACTIONS') === undefined)
+        return undefined;
+    const required = (name) => {
+        const found = value(name);
+        if (found === undefined)
+            throw new Error(`GITHUB_ACTIONS is set but ${name} is not`);
+        return found;
+    };
+    const repository = required('GITHUB_REPOSITORY');
+    const serverUrl = (value('GITHUB_SERVER_URL') ?? 'https://github.com').replace(/\/+$/, '');
+    const event = await readEvent(value('GITHUB_EVENT_PATH'), deps);
+    return {
+        repository,
+        serverUrl,
+        apiUrl: (value('GITHUB_API_URL') ?? 'https://api.github.com').replace(/\/+$/, ''),
+        runUrl: `${serverUrl}/${repository}/actions/runs/${required('GITHUB_RUN_ID')}`,
+        eventName: required('GITHUB_EVENT_NAME'),
+        workflow: required('GITHUB_WORKFLOW'),
+        job: required('GITHUB_JOB'),
+        sha: event === undefined ? value('GITHUB_SHA') : event.headSha,
+        pullRequest: event?.number ?? pullFromRef(value('GITHUB_REF')),
+        token: value('GITHUB_TOKEN') ?? value('GH_TOKEN'),
+        stepSummaryPath: value('GITHUB_STEP_SUMMARY'),
+    };
+}
+//# sourceMappingURL=actions.js.map

package/dist/actions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.js","sourceRoot":"","sources":["../src/actions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAiCrC,0EAA0E;AAC1E,SAAS,QAAQ,CAAC,GAAsB,EAAE,IAAY;IACpD,MAAM,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC;IACtB,OAAO,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;AACzE,CAAC;AAQD,SAAS,iBAAiB,CAAC,KAAc;IACvC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AAC/F,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,SAAS,CAAC,IAAwB,EAAE,IAAiB;IAClE,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACzC,IAAI,OAAgB,CAAC;IACrB,IAAI,CAAC;QACH,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IAClD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;QAAE,OAAO,SAAS,CAAC;IACzC,MAAM,IAAI,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IACrC,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACnB,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1B,OAAO;YACL,MAAM,EAAE,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACzC,OAAO,EAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS;SACrF,CAAC;IACJ,CAAC;IACD,2EAA2E;IAC3E,2EAA2E;IAC3E,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/B,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC;QACvD,OAAO,EAAE,MAAM,EAAE,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;IAC5E,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,+DAA+D;AAC/D,SAAS,WAAW,CAAC,GAAuB;IAC1C,MAAM,KAAK,GAAG,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,sBAAsB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1E,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,iBAAiB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1E,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,IAAiB;IACnD,MAAM,KAAK,GAAG,CAAC,IAAY,EAAsB,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC7E,IAAI,KAAK,CAAC,gBAAgB,CAAC,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC5D,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAU,EAAE;QACxC,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1B,IAAI,KAAK,KAAK,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,SAAS,CAAC,CAAC;QACrF,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,MAAM,UAAU,GAAG,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IACjD,MAAM,SAAS,GAAG,CAAC,KAAK,CAAC,mBAAmB,CAAC,IAAI,oBAAoB,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC3F,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,KAAK,CAAC,mBAAmB,CAAC,EAAE,IAAI,CAAC,CAAC;IAEhE,OAAO;QACL,UAAU;QACV,SAAS;QACT,MAAM,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC,IAAI,wBAAwB,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;QACjF,MAAM,EAAE,GAAG,SAAS,IAAI,UAAU,iBAAiB,QAAQ,CAAC,eAAe,CAAC,EAAE;QAC9E,SAAS,EAAE,QAAQ,CAAC,mBAAmB,CAAC;QACxC,QAAQ,EAAE,QAAQ,CAAC,iBAAiB,CAAC;QACrC,GAAG,EAAE,QAAQ,CAAC,YAAY,CAAC;QAC3B,GAAG,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO;QAC9D,WAAW,EAAE,KAAK,EAAE,MAAM,IAAI,WAAW,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC9D,KAAK,EAAE,KAAK,CAAC,cAAc,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC;QACjD,eAAe,EAAE,KAAK,CAAC,qBAAqB,CAAC;KAC9C,CAAC;AACJ,CAAC"}

package/dist/comment.d.ts

@@ -0,0 +1,29 @@
+/**
+ * The report-1 document as one pull request comment: a headline with the
+ * counts, the run-level errors, a table of every test that did not simply
+ * pass, the passed tests folded away, and where the evidence is.
+ *
+ * Everything a test wrote (titles, error messages) is untrusted text on its
+ * way into markdown GitHub renders, so cells are escaped and clipped. The
+ * builder is exported so a hosted run page can render the same comment.
+ */
+import type { Report } from '@e2edev/e2e';
+export interface CommentOptions {
+    /** A hidden HTML comment the reporter finds its own comment by; left out of a job summary. */
+    readonly marker?: string | undefined;
+    /** Where the run's artifacts can be fetched: the workflow run page, or a hosted run page. */
+    readonly artifactsUrl?: string | undefined;
+    /** A link to a source line, when the commit is known. */
+    readonly sourceUrl?: ((file: string, line: number) => string) | undefined;
+}
+/**
+ * A marker is what a rerun finds the comment by, so it can never be cut. With
+ * it bounded, the head and footer together stay far under the budget and the
+ * body is the only part that ever gives way.
+ */
+export declare const MAX_MARKER_CHARS = 1024;
+/** The artifacts link sits in the footer beside the marker, so it is bounded the same way. */
+export declare const MAX_URL_CHARS = 2048;
+/** Renders the run as a pull request comment body. */
+export declare function renderComment(report: Report, options?: CommentOptions): string;
+//# sourceMappingURL=comment.d.ts.map

package/dist/comment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"comment.d.ts","sourceRoot":"","sources":["../src/comment.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAGH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAQ1C,MAAM,WAAW,cAAc;IAC7B,8FAA8F;IAC9F,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,6FAA6F;IAC7F,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3C,yDAAyD;IACzD,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,SAAS,CAAC;CAC3E;AAWD;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,OAAQ,CAAC;AACtC,8FAA8F;AAC9F,eAAO,MAAM,aAAa,OAAQ,CAAC;AA2InC,sDAAsD;AACtD,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB,GAAG,MAAM,CA2ElF"}

package/dist/comment.js

@@ -0,0 +1,209 @@
+/**
+ * The report-1 document as one pull request comment: a headline with the
+ * counts, the run-level errors, a table of every test that did not simply
+ * pass, the passed tests folded away, and where the evidence is.
+ *
+ * Everything a test wrote (titles, error messages) is untrusted text on its
+ * way into markdown GitHub renders, so cells are escaped and clipped. The
+ * builder is exported so a hosted run page can render the same comment.
+ */
+import { stripVTControlCharacters } from 'node:util';
+/** GitHub rejects a comment body past 65536 characters; stay clear of it. */
+const MAX_BODY_CHARS = 60_000;
+/** Reader caps, not size guards: past these the comment says how many more there are. */
+const MAX_TABLE_ROWS = 50;
+const MAX_RUN_ERRORS = 20;
+const MAX_PASSED_LINES = 200;
+const MAX_FOOTER_TARGETS = 8;
+const MAX_CELL_CHARS = 240;
+const TRUNCATED_NOTE = "_Comment truncated to fit GitHub's size limit; the full report is in the run artifacts._";
+/**
+ * A marker is what a rerun finds the comment by, so it can never be cut. With
+ * it bounded, the head and footer together stay far under the budget and the
+ * body is the only part that ever gives way.
+ */
+export const MAX_MARKER_CHARS = 1_024;
+/** The artifacts link sits in the footer beside the marker, so it is bounded the same way. */
+export const MAX_URL_CHARS = 2_048;
+/** C0/C1 control characters except tab and newline; ANSI sequences are stripped first. */
+// oxlint-disable-next-line no-control-regex -- the control range is the point
+const CONTROL_PATTERN = /[\x00-\x08\x0b-\x1f\x7f-\x9f]/g;
+/** One line of plain text: no color codes, no control characters, no line breaks. */
+function plain(text) {
+    return stripVTControlCharacters(text).replace(CONTROL_PATTERN, '').replace(/\s+/g, ' ').trim();
+}
+/** Clips by code point, so an emoji at the cut never becomes a lone surrogate. */
+function clip(text, max) {
+    const points = [...text];
+    return points.length <= max ? text : `${points.slice(0, max - 1).join('')}…`;
+}
+/**
+ * Text safe inside a table cell: markdown that could open a construct is
+ * escaped, angle brackets become entities so no HTML gets through, and the
+ * cell separator is escaped. An underscore stays: inside a word GitHub
+ * never reads it as emphasis, and error codes are full of them.
+ */
+function cell(text, max = MAX_CELL_CHARS) {
+    return clip(plain(text), max)
+        .replace(/[\\`*[\]~|]/g, (char) => `\\${char}`)
+        .replaceAll('<', '&lt;')
+        .replaceAll('>', '&gt;');
+}
+function formatDuration(ms) {
+    if (ms < 1_000)
+        return `${Math.round(ms)}ms`;
+    if (ms < 60_000)
+        return `${(ms / 1_000).toFixed(1)}s`;
+    // Round to whole seconds first, so 119.5 s is 2m 0s and never 1m 60s.
+    const total = Math.round(ms / 1_000);
+    return `${Math.floor(total / 60)}m ${total % 60}s`;
+}
+function plural(count, noun) {
+    return `${count} ${noun}${count === 1 ? '' : 's'}`;
+}
+function outcome(result, groups) {
+    const attempts = result.serialGroupId === undefined ? result.attempts : (groups.get(result.serialGroupId)?.attempts ?? []);
+    const last = attempts.at(-1);
+    const member = result.serialGroupId === undefined || last === undefined || !('members' in last)
+        ? undefined
+        : last.members.find((candidate) => candidate.testId === result.testId);
+    return {
+        durationMs: member?.durationMs ?? last?.durationMs ?? 0,
+        error: member?.error ?? last?.error,
+        failedAttempts: attempts.slice(0, -1).filter((attempt) => attempt.status !== 'passed').length,
+        artifactKinds: kinds(attempts.flatMap((attempt) => attempt.artifacts)),
+    };
+}
+/** Screenshots first, then the recording, then the trace; the compiler fails when a kind is missing here. */
+const KIND_RANK = { screenshot: 0, video: 1, trace: 2, download: 3, log: 4 };
+function kinds(artifacts) {
+    return [...new Set(artifacts.map((artifact) => artifact.kind))].toSorted((a, b) => KIND_RANK[a] - KIND_RANK[b]);
+}
+function bucket(status) {
+    return status === 'passed' || status === 'flaky' || status === 'skipped' ? status : 'failed';
+}
+const ICON = { failed: '🔴', flaky: '⚠️', skipped: '⏭️', passed: '🟢' };
+/** The order the table lists what did not pass; passed tests fold away below it. */
+const LISTED = ['failed', 'flaky', 'skipped'];
+function groupByBucket(results) {
+    const groups = new Map();
+    for (const result of results) {
+        const key = bucket(result.status);
+        groups.set(key, [...(groups.get(key) ?? []), result]);
+    }
+    return groups;
+}
+function headline(run, groups) {
+    const parts = ['failed', 'flaky', 'passed', 'skipped']
+        .filter((key) => (groups.get(key)?.length ?? 0) > 0)
+        .map((key) => `${groups.get(key)?.length} ${key}`);
+    const summary = parts.length > 0 ? parts.join(', ') : run.errors.length > 0 ? 'no tests ran' : 'no tests selected';
+    return `### ${run.status === 'passed' ? ICON.passed : ICON.failed} e2e: ${summary}`;
+}
+function errorText(error) {
+    const phase = error.phase === undefined ? '' : ` (${plain(error.phase)})`;
+    return `**${cell(error.code, 128)}**${phase} ${cell(error.message)}`.trim();
+}
+function outcomeCell(result, final) {
+    if (result.status === 'flaky' && final.failedAttempts > 0) {
+        return `flaky: passed after ${plural(final.failedAttempts, 'failed attempt')}`;
+    }
+    if (result.status === 'skipped')
+        return `skipped: ${cell(result.skip?.reason ?? 'skipped')}`;
+    return final.error === undefined ? cell(result.status) : errorText(final.error);
+}
+function evidenceCell(final, options) {
+    if (final.artifactKinds.length === 0)
+        return '';
+    const text = final.artifactKinds.join(', ');
+    return options.artifactsUrl === undefined ? text : `[${text}](${options.artifactsUrl})`;
+}
+function footer(run, options) {
+    const duration = formatDuration(Date.parse(run.finishedAt) - Date.parse(run.startedAt));
+    const shown = run.targets.slice(0, MAX_FOOTER_TARGETS).map((target) => cell(target.id, 64));
+    if (run.targets.length > shown.length)
+        shown.push(`and ${run.targets.length - shown.length} more`);
+    const targets = shown.length === 0 ? '' : ` (${shown.join(', ')})`;
+    return [
+        ...(options.artifactsUrl === undefined
+            ? []
+            : [`Screenshots, traces, and recordings: [run artifacts](${options.artifactsUrl}).`]),
+        `<sub>e2e ${cell(run.runner.version, 64)} · ${duration} · ${plural(run.targets.length, 'target')}${targets}</sub>`,
+    ];
+}
+/** Renders the run as a pull request comment body. */
+export function renderComment(report, options = {}) {
+    if (options.marker !== undefined && options.marker.length > MAX_MARKER_CHARS) {
+        throw new Error(`renderComment: marker must be at most ${MAX_MARKER_CHARS} characters, got ${options.marker.length}`);
+    }
+    if (options.artifactsUrl !== undefined && options.artifactsUrl.length > MAX_URL_CHARS) {
+        throw new Error(`renderComment: artifactsUrl must be at most ${MAX_URL_CHARS} characters, got ${options.artifactsUrl.length}`);
+    }
+    const run = report.run;
+    const serialGroups = new Map(run.serialGroups.map((group) => [group.id, group]));
+    const groups = groupByBucket(run.results);
+    const manyTargets = run.targets.length > 1;
+    /** `file:line › suite › title (target)`, the location linked when the commit is known. */
+    const name = (result, location) => {
+        const title = result.titlePath.map((part) => cell(part, 120)).join(' › ');
+        return `${location} › ${title}${manyTargets ? ` (${cell(result.targetId, 64)})` : ''}`;
+    };
+    const linked = (result) => {
+        const location = `${result.source.file}:${result.source.line}`;
+        return options.sourceUrl === undefined
+            ? `\`${plain(location).replaceAll('`', '')}\``
+            : `[${cell(location)}](${options.sourceUrl(result.source.file, result.source.line)})`;
+    };
+    // Body parts in priority order; each is one line, except the passed list,
+    // which is one block since a `<details>` cannot be cut halfway.
+    const errors = run.errors.slice(0, MAX_RUN_ERRORS).map((error) => `> ${errorText(error)}`);
+    if (run.errors.length > errors.length)
+        errors.push(`> and ${run.errors.length - errors.length} more`);
+    const listed = LISTED.flatMap((key) => groups.get(key) ?? []);
+    const rows = listed.slice(0, MAX_TABLE_ROWS).map((result) => {
+        const final = outcome(result, serialGroups);
+        return `| ${ICON[bucket(result.status)]} | ${name(result, linked(result))} | ${outcomeCell(result, final)} | ${evidenceCell(final, options)} |`;
+    });
+    const table = rows.length === 0 ? [] : ['| | Test | Outcome | Evidence |', '| --- | --- | --- | --- |', ...rows];
+    if (listed.length > rows.length)
+        table.push(`| | and ${listed.length - rows.length} more | | |`);
+    const passed = groups.get('passed') ?? [];
+    const passedBlock = passed.length === 0
+        ? []
+        : [
+            [
+                '<details>',
+                `<summary>${plural(passed.length, 'passed test')}</summary>`,
+                '',
+                ...passed
+                    .slice(0, MAX_PASSED_LINES)
+                    .map((result) => `- ${name(result, cell(result.file, 200))} (${formatDuration(outcome(result, serialGroups).durationMs)})`),
+                ...(passed.length > MAX_PASSED_LINES ? [`- and ${passed.length - MAX_PASSED_LINES} more`] : []),
+                '</details>',
+            ].join('\n'),
+        ];
+    const sections = [errors, table, passedBlock].filter((section) => section.length > 0);
+    const head = [...(options.marker === undefined ? [] : [options.marker]), headline(run, groups), ''];
+    const tail = footer(run, options);
+    const render = (body) => `${[...head, ...body, ...tail].join('\n')}\n`;
+    // Greedy fit: keep whole parts in order while they fit, then say what was cut.
+    let size = render([TRUNCATED_NOTE]).length;
+    const body = [];
+    let cut = false;
+    for (const section of sections) {
+        for (const part of section) {
+            if (size + part.length + 1 > MAX_BODY_CHARS) {
+                cut = true;
+                break;
+            }
+            body.push(part);
+            size += part.length + 1;
+        }
+        if (cut)
+            break;
+        body.push('');
+        size += 1;
+    }
+    return render(cut ? [...body, TRUNCATED_NOTE] : body);
+}
+//# sourceMappingURL=comment.js.map

package/dist/comment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"comment.js","sourceRoot":"","sources":["../src/comment.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAC;AAkBrD,6EAA6E;AAC7E,MAAM,cAAc,GAAG,MAAM,CAAC;AAC9B,yFAAyF;AACzF,MAAM,cAAc,GAAG,EAAE,CAAC;AAC1B,MAAM,cAAc,GAAG,EAAE,CAAC;AAC1B,MAAM,gBAAgB,GAAG,GAAG,CAAC;AAC7B,MAAM,kBAAkB,GAAG,CAAC,CAAC;AAC7B,MAAM,cAAc,GAAG,GAAG,CAAC;AAC3B,MAAM,cAAc,GAAG,0FAA0F,CAAC;AAClH;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,CAAC;AACtC,8FAA8F;AAC9F,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,CAAC;AAEnC,0FAA0F;AAC1F,8EAA8E;AAC9E,MAAM,eAAe,GAAG,gCAAgC,CAAC;AAEzD,qFAAqF;AACrF,SAAS,KAAK,CAAC,IAAY;IACzB,OAAO,wBAAwB,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;AACjG,CAAC;AAED,kFAAkF;AAClF,SAAS,IAAI,CAAC,IAAY,EAAE,GAAW;IACrC,MAAM,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IACzB,OAAO,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC;AAC/E,CAAC;AAED;;;;;GAKG;AACH,SAAS,IAAI,CAAC,IAAY,EAAE,GAAG,GAAG,cAAc;IAC9C,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC;SAC1B,OAAO,CAAC,cAAc,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC;SAC9C,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC;SACvB,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;AAC7B,CAAC;AAED,SAAS,cAAc,CAAC,EAAU;IAChC,IAAI,EAAE,GAAG,KAAK;QAAE,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC;IAC7C,IAAI,EAAE,GAAG,MAAM;QAAE,OAAO,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;IACtD,sEAAsE;IACtE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC;IACrC,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,EAAE,CAAC,KAAK,KAAK,GAAG,EAAE,GAAG,CAAC;AACrD,CAAC;AAED,SAAS,MAAM,CAAC,KAAa,EAAE,IAAY;IACzC,OAAO,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;AACrD,CAAC;AAiBD,SAAS,OAAO,CAAC,MAAoB,EAAE,MAA8C;IACnF,MAAM,QAAQ,GAAG,MAAM,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,QAAQ,IAAI,EAAE,CAAC,CAAC;IAC3H,MAAM,IAAI,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7B,MAAM,MAAM,GACV,MAAM,CAAC,aAAa,KAAK,SAAS,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,CAAC,SAAS,IAAI,IAAI,CAAC;QAC9E,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC;IAC3E,OAAO;QACL,UAAU,EAAE,MAAM,EAAE,UAAU,IAAI,IAAI,EAAE,UAAU,IAAI,CAAC;QACvD,KAAK,EAAE,MAAM,EAAE,KAAK,IAAI,IAAI,EAAE,KAAK;QACnC,cAAc,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,MAAM;QAC7F,aAAa,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;KACvE,CAAC;AACJ,CAAC;AAED,6GAA6G;AAC7G,MAAM,SAAS,GAAiC,EAAE,UAAU,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC;AAE3G,SAAS,KAAK,CAAC,SAAqD;IAClE,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAClH,CAAC;AAID,SAAS,MAAM,CAAC,MAA8B;IAC5C,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,OAAO,IAAI,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC;AAC/F,CAAC;AAED,MAAM,IAAI,GAA2B,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;AAEhG,oFAAoF;AACpF,MAAM,MAAM,GAAsB,CAAC,QAAQ,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;AAEjE,SAAS,aAAa,CAAC,OAAgC;IACrD,MAAM,MAAM,GAAG,IAAI,GAAG,EAA0B,CAAC;IACjD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAClC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IACxD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,QAAQ,CAAC,GAAc,EAAE,MAAoD;IACpF,MAAM,KAAK,GAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAW;SAC9D,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;SACnD,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC;IACrD,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,mBAAmB,CAAC;IACnH,OAAO,OAAO,GAAG,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,SAAS,OAAO,EAAE,CAAC;AACtF,CAAC;AAED,SAAS,SAAS,CAAC,KAAkB;IACnC,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC;IAC1E,OAAO,KAAK,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;AAC9E,CAAC;AAED,SAAS,WAAW,CAAC,MAAoB,EAAE,KAAc;IACvD,IAAI,MAAM,CAAC,MAAM,KAAK,OAAO,IAAI,KAAK,CAAC,cAAc,GAAG,CAAC,EAAE,CAAC;QAC1D,OAAO,uBAAuB,MAAM,CAAC,KAAK,CAAC,cAAc,EAAE,gBAAgB,CAAC,EAAE,CAAC;IACjF,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS;QAAE,OAAO,YAAY,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,IAAI,SAAS,CAAC,EAAE,CAAC;IAC7F,OAAO,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAClF,CAAC;AAED,SAAS,YAAY,CAAC,KAAc,EAAE,OAAuB;IAC3D,IAAI,KAAK,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAChD,MAAM,IAAI,GAAG,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,OAAO,OAAO,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,KAAK,OAAO,CAAC,YAAY,GAAG,CAAC;AAC1F,CAAC;AAED,SAAS,MAAM,CAAC,GAAc,EAAE,OAAuB;IACrD,MAAM,QAAQ,GAAG,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;IACxF,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,kBAAkB,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IAC5F,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM;QAAE,KAAK,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,OAAO,CAAC,CAAC;IACnG,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;IACnE,OAAO;QACL,GAAG,CAAC,OAAO,CAAC,YAAY,KAAK,SAAS;YACpC,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,CAAC,wDAAwD,OAAO,CAAC,YAAY,IAAI,CAAC,CAAC;QACvF,YAAY,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC,MAAM,QAAQ,MAAM,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,OAAO,QAAQ;KACnH,CAAC;AACJ,CAAC;AAED,sDAAsD;AACtD,MAAM,UAAU,aAAa,CAAC,MAAc,EAAE,OAAO,GAAmB,EAAE;IACxE,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,gBAAgB,EAAE,CAAC;QAC7E,MAAM,IAAI,KAAK,CAAC,yCAAyC,gBAAgB,oBAAoB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACxH,CAAC;IACD,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,IAAI,OAAO,CAAC,YAAY,CAAC,MAAM,GAAG,aAAa,EAAE,CAAC;QACtF,MAAM,IAAI,KAAK,CAAC,+CAA+C,aAAa,oBAAoB,OAAO,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IACjI,CAAC;IACD,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;IACvB,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IACjF,MAAM,MAAM,GAAG,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC1C,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;IAE3C,0FAA0F;IAC1F,MAAM,IAAI,GAAG,CAAC,MAAoB,EAAE,QAAgB,EAAU,EAAE;QAC9D,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC1E,OAAO,GAAG,QAAQ,MAAM,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IACzF,CAAC,CAAC;IACF,MAAM,MAAM,GAAG,CAAC,MAAoB,EAAU,EAAE;QAC9C,MAAM,QAAQ,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QAC/D,OAAO,OAAO,CAAC,SAAS,KAAK,SAAS;YACpC,CAAC,CAAC,KAAK,KAAK,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI;YAC9C,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;IAC1F,CAAC,CAAC;IAEF,0EAA0E;IAC1E,gEAAgE;IAChE,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC3F,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM;QAAE,MAAM,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,OAAO,CAAC,CAAC;IACtG,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IAC9D,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QAC1D,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;QAC5C,OAAO,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC;IAClJ,CAAC,CAAC,CAAC;IACH,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,iCAAiC,EAAE,2BAA2B,EAAE,GAAG,IAAI,CAAC,CAAC;IACjH,IAAI,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM;QAAE,KAAK,CAAC,IAAI,CAAC,WAAW,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,aAAa,CAAC,CAAC;IACjG,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC1C,MAAM,WAAW,GACf,MAAM,CAAC,MAAM,KAAK,CAAC;QACjB,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC;YACE;gBACE,WAAW;gBACX,YAAY,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,YAAY;gBAC5D,EAAE;gBACF,GAAG,MAAM;qBACN,KAAK,CAAC,CAAC,EAAE,gBAAgB,CAAC;qBAC1B,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,KAAK,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC;gBAC7H,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,GAAG,gBAAgB,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC/F,YAAY;aACb,CAAC,IAAI,CAAC,IAAI,CAAC;SACb,CAAC;IACR,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAEtF,MAAM,IAAI,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;IACpG,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAClC,MAAM,MAAM,GAAG,CAAC,IAAuB,EAAU,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IAElG,+EAA+E;IAC/E,IAAI,IAAI,GAAG,MAAM,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC;IAC3C,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,IAAI,GAAG,GAAG,KAAK,CAAC;IAChB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC3B,IAAI,IAAI,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,cAAc,EAAE,CAAC;gBAC5C,GAAG,GAAG,IAAI,CAAC;gBACX,MAAM;YACR,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAChB,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;QAC1B,CAAC;QACD,IAAI,GAAG;YAAE,MAAM;QACf,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACd,IAAI,IAAI,CAAC,CAAC;IACZ,CAAC;IACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AACxD,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * `@e2edev/github` public surface: the `github()` reporter factory and the
+ * comment builder it uses. The reporter posts one pull request comment per
+ * run from GitHub Actions, through the `reporters` seam of `@e2edev/e2e`,
+ * and writes the same text to the job summary.
+ */
+export { github } from './reporter.ts';
+export type { GitHubOptions } from './reporter.ts';
+export { renderComment, MAX_MARKER_CHARS, MAX_URL_CHARS } from './comment.ts';
+export type { CommentOptions } from './comment.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,YAAY,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC9E,YAAY,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC"}

package/dist/index.js

@@ -0,0 +1,9 @@
+/**
+ * `@e2edev/github` public surface: the `github()` reporter factory and the
+ * comment builder it uses. The reporter posts one pull request comment per
+ * run from GitHub Actions, through the `reporters` seam of `@e2edev/e2e`,
+ * and writes the same text to the job summary.
+ */
+export { github } from './reporter.js';
+export { renderComment, MAX_MARKER_CHARS, MAX_URL_CHARS } from './comment.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAEvC,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC"}

package/dist/json.d.ts

@@ -0,0 +1,3 @@
+/** A parsed JSON object, as opposed to an array, a primitive, or null. */
+export declare function isRecord(value: unknown): value is Record<string, unknown>;
+//# sourceMappingURL=json.d.ts.map

package/dist/json.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.d.ts","sourceRoot":"","sources":["../src/json.ts"],"names":[],"mappings":"AAAA,0EAA0E;AAC1E,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEzE"}

package/dist/json.js

@@ -0,0 +1,5 @@
+/** A parsed JSON object, as opposed to an array, a primitive, or null. */
+export function isRecord(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+//# sourceMappingURL=json.js.map

package/dist/json.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.js","sourceRoot":"","sources":["../src/json.ts"],"names":[],"mappings":"AAAA,0EAA0E;AAC1E,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC"}

package/dist/post.d.ts

@@ -0,0 +1,25 @@
+/**
+ * One comment per pull request, kept current: the reporter looks for the
+ * comment carrying its marker and edits it, and creates one only when none
+ * exists. The REST calls are the three GitHub documents them as: list the
+ * issue's comments, update a comment, create a comment.
+ *
+ * Every request carries the reporter's abort signal. Anything GitHub answers
+ * outside the protocol is an error naming itself; the runner prints one line.
+ */
+export interface PostParams {
+    readonly fetch: typeof fetch;
+    readonly signal: AbortSignal;
+    /** `https://api.github.com`, or an Enterprise Server API root. */
+    readonly apiUrl: string;
+    readonly token: string;
+    /** `owner/repo`. */
+    readonly repository: string;
+    readonly pullRequest: number;
+    /** The hidden HTML comment that identifies the reporter's own comment. */
+    readonly marker: string;
+    readonly body: string;
+}
+/** Creates or updates the reporter's comment and resolves with its URL. */
+export declare function upsertComment(params: PostParams): Promise<string>;
+//# sourceMappingURL=post.d.ts.map

package/dist/post.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"post.d.ts","sourceRoot":"","sources":["../src/post.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,KAAK,EAAE,OAAO,KAAK,CAAC;IAC7B,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAC7B,kEAAkE;IAClE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,oBAAoB;IACpB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,0EAA0E;IAC1E,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAqDD,2EAA2E;AAC3E,wBAAsB,aAAa,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAWvE"}

package/dist/post.js

@@ -0,0 +1,69 @@
+/**
+ * One comment per pull request, kept current: the reporter looks for the
+ * comment carrying its marker and edits it, and creates one only when none
+ * exists. The REST calls are the three GitHub documents them as: list the
+ * issue's comments, update a comment, create a comment.
+ *
+ * Every request carries the reporter's abort signal. Anything GitHub answers
+ * outside the protocol is an error naming itself; the runner prints one line.
+ */
+import { isRecord } from './json.js';
+const PER_PAGE = 100;
+/**
+ * The list is followed until a short page says it is exhausted. The cap is a
+ * guard against a server that never sends one, not a limit any pull request
+ * reaches: ten thousand comments.
+ */
+const MAX_PAGES = 100;
+const USER_AGENT = '@e2edev/github';
+/** One GitHub REST call; anything but success is an error the runner can print. */
+async function request(params, method, route, body) {
+    const response = await params.fetch(`${params.apiUrl}${route}`, {
+        method,
+        headers: {
+            authorization: `Bearer ${params.token}`,
+            accept: 'application/vnd.github+json',
+            'x-github-api-version': '2022-11-28',
+            'user-agent': USER_AGENT,
+            ...(body === undefined ? {} : { 'content-type': 'application/json' }),
+        },
+        ...(body === undefined ? {} : { body: JSON.stringify(body) }),
+        signal: params.signal,
+    });
+    if (response.ok)
+        return response.json().catch(() => undefined);
+    const detail = (await response.text().catch(() => '')).slice(0, 200);
+    if (response.status === 401)
+        throw new Error('GitHub rejected the token (GITHUB_TOKEN or GH_TOKEN)');
+    if (response.status === 403 || response.status === 404) {
+        throw new Error(`the token cannot comment on ${params.repository}#${params.pullRequest}: a pull request from a fork runs with a read-only token, and the job needs \`permissions: pull-requests: write\``);
+    }
+    throw new Error(`GitHub responded ${response.status} to ${method} ${route}${detail === '' ? '' : `: ${detail}`}`);
+}
+/** The id of the comment carrying the marker, or undefined when no page has one. */
+async function findComment(params, issue) {
+    for (let page = 1; page <= MAX_PAGES; page += 1) {
+        const comments = await request(params, 'GET', `${issue}/comments?per_page=${PER_PAGE}&page=${page}`);
+        if (!Array.isArray(comments))
+            throw new Error('GitHub answered the comment list with a body that is not a list');
+        const found = comments.find((comment) => isRecord(comment) && typeof comment['body'] === 'string' && comment['body'].includes(params.marker));
+        if (isRecord(found) && typeof found['id'] === 'number')
+            return found['id'];
+        if (comments.length < PER_PAGE)
+            return undefined;
+    }
+    return undefined;
+}
+/** Creates or updates the reporter's comment and resolves with its URL. */
+export async function upsertComment(params) {
+    const issue = `/repos/${params.repository}/issues/${params.pullRequest}`;
+    const existing = await findComment(params, issue);
+    const created = existing === undefined
+        ? await request(params, 'POST', `${issue}/comments`, { body: params.body })
+        : await request(params, 'PATCH', `/repos/${params.repository}/issues/comments/${existing}`, { body: params.body });
+    if (!isRecord(created) || typeof created['html_url'] !== 'string') {
+        throw new Error('GitHub answered the comment without its html_url');
+    }
+    return created['html_url'];
+}
+//# sourceMappingURL=post.js.map

package/dist/post.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"post.js","sourceRoot":"","sources":["../src/post.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAgBrC,MAAM,QAAQ,GAAG,GAAG,CAAC;AACrB;;;;GAIG;AACH,MAAM,SAAS,GAAG,GAAG,CAAC;AACtB,MAAM,UAAU,GAAG,gBAAgB,CAAC;AAIpC,mFAAmF;AACnF,KAAK,UAAU,OAAO,CAAC,MAAkB,EAAE,MAAc,EAAE,KAAa,EAAE,IAAc;IACtF,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,GAAG,KAAK,EAAE,EAAE;QAC9D,MAAM;QACN,OAAO,EAAE;YACP,aAAa,EAAE,UAAU,MAAM,CAAC,KAAK,EAAE;YACvC,MAAM,EAAE,6BAA6B;YACrC,sBAAsB,EAAE,YAAY;YACpC,YAAY,EAAE,UAAU;YACxB,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC;SACtE;QACD,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7D,MAAM,EAAE,MAAM,CAAC,MAAM;KACtB,CAAC,CAAC;IACH,IAAI,QAAQ,CAAC,EAAE;QAAE,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC/D,MAAM,MAAM,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACrE,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG;QAAE,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;IACrG,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;QACvD,MAAM,IAAI,KAAK,CACb,+BAA+B,MAAM,CAAC,UAAU,IAAI,MAAM,CAAC,WAAW,mHAAmH,CAC1L,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,oBAAoB,QAAQ,CAAC,MAAM,OAAO,MAAM,IAAI,KAAK,GAAG,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE,EAAE,CAAC,CAAC;AACpH,CAAC;AAED,oFAAoF;AACpF,KAAK,UAAU,WAAW,CAAC,MAAkB,EAAE,KAAa;IAC1D,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,IAAI,SAAS,EAAE,IAAI,IAAI,CAAC,EAAE,CAAC;QAChD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,sBAAsB,QAAQ,SAAS,IAAI,EAAE,CAAC,CAAC;QACrG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAC;QACjH,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CACzB,CAAC,OAAgB,EAAE,EAAE,CACnB,QAAQ,CAAC,OAAO,CAAC,IAAI,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CACtG,CAAC;QACF,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC;QAC3E,IAAI,QAAQ,CAAC,MAAM,GAAG,QAAQ;YAAE,OAAO,SAAS,CAAC;IACnD,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,2EAA2E;AAC3E,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,MAAkB;IACpD,MAAM,KAAK,GAAG,UAAU,MAAM,CAAC,UAAU,WAAW,MAAM,CAAC,WAAW,EAAE,CAAC;IACzE,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAClD,MAAM,OAAO,GACX,QAAQ,KAAK,SAAS;QACpB,CAAC,CAAC,MAAM,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,WAAW,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC;QAC3E,CAAC,CAAC,MAAM,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,UAAU,MAAM,CAAC,UAAU,oBAAoB,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IACvH,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,OAAO,OAAO,CAAC,UAAU,CAAC,KAAK,QAAQ,EAAE,CAAC;QAClE,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC;IACD,OAAO,OAAO,CAAC,UAAU,CAAC,CAAC;AAC7B,CAAC"}

package/dist/reporter.d.ts

@@ -0,0 +1,33 @@
+import type { FinishedRun, Reporter, ReporterSummary } from '@e2edev/e2e';
+import { type ActionsDeps } from './actions.ts';
+export interface GitHubOptions {
+    /**
+     * Tells one job's comment apart from another's when the workflow, job, and
+     * project are the same, as in a matrix: `key: process.env.MATRIX_BROWSER`.
+     * Without it, matrix replicas of one job share a comment and the last one
+     * to finish wins. Never the run id: a rerun must find the old comment.
+     */
+    key?: string;
+}
+/** What the reporter touches outside itself, so tests run it against fakes. */
+export interface ReportDeps extends ActionsDeps {
+    readonly fetch: typeof fetch;
+    readonly appendFile: (file: string, text: string) => Promise<void>;
+}
+/**
+ * The GitHub reporter. Add it to `reporters` beside the built-in ids:
+ *
+ * ```ts
+ * import { github } from '@e2edev/github';
+ * export default { targets, reporters: ['list', github()] } satisfies E2EConfig;
+ * ```
+ *
+ * On GitHub Actions it writes the run to the job summary and, for a pull
+ * request, posts or updates one comment. Everything it reads (the token, the
+ * event, the repository) is read when the run finishes, never when the config
+ * loads, so constructing it has no side effects.
+ */
+export declare function github(options?: GitHubOptions): Reporter;
+/** Reports one finished run and resolves with the summary rows describing what happened. */
+export declare function reportRun(run: FinishedRun, signal: AbortSignal, options: GitHubOptions, deps: ReportDeps): Promise<ReporterSummary>;
+//# sourceMappingURL=reporter.d.ts.map

package/dist/reporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reporter.d.ts","sourceRoot":"","sources":["../src/reporter.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC1E,OAAO,EAAsC,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAMpF,MAAM,WAAW,aAAa;IAC5B;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,+EAA+E;AAC/E,MAAM,WAAW,UAAW,SAAQ,WAAW;IAC7C,QAAQ,CAAC,KAAK,EAAE,OAAO,KAAK,CAAC;IAC7B,QAAQ,CAAC,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACpE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,MAAM,CAAC,OAAO,GAAE,aAAkB,GAAG,QAAQ,CAW5D;AA+DD,4FAA4F;AAC5F,wBAAsB,SAAS,CAC7B,GAAG,EAAE,WAAW,EAChB,MAAM,EAAE,WAAW,EACnB,OAAO,EAAE,aAAa,EACtB,IAAI,EAAE,UAAU,GACf,OAAO,CAAC,eAAe,CAAC,CAyB1B"}

package/dist/reporter.js

@@ -0,0 +1,107 @@
+import { appendFile, readFile } from 'node:fs/promises';
+import { detectActions } from './actions.js';
+import { renderComment } from './comment.js';
+import { upsertComment } from './post.js';
+const SUMMARY_LABEL = 'GitHub';
+/**
+ * The GitHub reporter. Add it to `reporters` beside the built-in ids:
+ *
+ * ```ts
+ * import { github } from '@e2edev/github';
+ * export default { targets, reporters: ['list', github()] } satisfies E2EConfig;
+ * ```
+ *
+ * On GitHub Actions it writes the run to the job summary and, for a pull
+ * request, posts or updates one comment. Everything it reads (the token, the
+ * event, the repository) is read when the run finishes, never when the config
+ * loads, so constructing it has no side effects.
+ */
+export function github(options = {}) {
+    return {
+        name: 'github',
+        onRunFinished: (run, signal) => reportRun(run, signal, options, {
+            fetch: globalThis.fetch,
+            env: process.env,
+            readFile: (file) => readFile(file, 'utf8'),
+            appendFile: (file, text) => appendFile(file, text, 'utf8'),
+        }),
+    };
+}
+/**
+ * Each encoded marker field is cut to this many characters, so four fields
+ * and their names stay under `MAX_MARKER_CHARS` whatever the input. The cut
+ * never lands inside a percent escape, and it is the same on every run.
+ */
+const MAX_MARKER_FIELD_CHARS = 200;
+function markerField(value) {
+    const encoded = encodeURIComponent(value);
+    if (encoded.length <= MAX_MARKER_FIELD_CHARS)
+        return encoded;
+    return encoded.slice(0, MAX_MARKER_FIELD_CHARS).replace(/%[0-9A-F]?$/, '');
+}
+/**
+ * The marker one job's comment carries, so two workflows or jobs each keep
+ * their own. Every field is cut the same way on every run, so a rerun
+ * derives the same marker and finds its comment.
+ */
+function commentMarker(run, context, key) {
+    const fields = {
+        project: run.report.run.project.id,
+        workflow: context.workflow,
+        job: context.job,
+        key,
+    };
+    const parts = Object.entries(fields).flatMap(([name, value]) => value === undefined || value === '' ? [] : [`${name}=${markerField(value)}`]);
+    return `<!-- e2e-github ${parts.join(' ')} -->`;
+}
+function sourceUrl(context) {
+    const sha = context.sha;
+    if (sha === undefined)
+        return undefined;
+    return (file, line) => `${context.serverUrl}/${context.repository}/blob/${sha}/${file.split('/').map(encodeURIComponent).join('/')}#L${line}`;
+}
+function posting(context) {
+    if (context.pullRequest === undefined)
+        return { skipped: `${context.eventName} is not a pull request` };
+    if (context.token === undefined) {
+        return { skipped: "set GITHUB_TOKEN in the step's env (GITHUB_TOKEN: ${{ github.token }})" };
+    }
+    return { token: context.token, pullRequest: context.pullRequest };
+}
+async function writeSummary(context, text, deps) {
+    if (context.stepSummaryPath === undefined)
+        return 'none';
+    try {
+        await deps.appendFile(context.stepSummaryPath, `${text}\n`);
+        return 'written';
+    }
+    catch (error) {
+        return { failed: error instanceof Error ? error.message : String(error) };
+    }
+}
+/** Reports one finished run and resolves with the summary rows describing what happened. */
+export async function reportRun(run, signal, options, deps) {
+    const context = await detectActions(deps);
+    if (context === undefined)
+        return [{ label: SUMMARY_LABEL, text: 'not posted: not running on GitHub Actions' }];
+    const links = { artifactsUrl: context.runUrl, sourceUrl: sourceUrl(context) };
+    const summary = await writeSummary(context, renderComment(run.report, links), deps);
+    const post = posting(context);
+    const marker = commentMarker(run, context, options.key);
+    const lead = 'skipped' in post
+        ? `not posted: ${post.skipped}${summary === 'written' ? '; written to the job summary' : ''}`
+        : await upsertComment({
+            fetch: deps.fetch,
+            signal,
+            apiUrl: context.apiUrl,
+            repository: context.repository,
+            ...post,
+            marker,
+            body: renderComment(run.report, { ...links, marker }),
+        });
+    return [
+        { label: SUMMARY_LABEL, text: lead },
+        ...(typeof summary === 'object' ? [{ label: SUMMARY_LABEL, text: `job summary not written: ${summary.failed}` }] : []),
+    ];
+}
+//# sourceMappingURL=reporter.js.map

package/dist/reporter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reporter.js","sourceRoot":"","sources":["../src/reporter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAExD,OAAO,EAAE,aAAa,EAAyC,MAAM,cAAc,CAAC;AACpF,OAAO,EAAE,aAAa,EAAuB,MAAM,cAAc,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE1C,MAAM,aAAa,GAAG,QAAQ,CAAC;AAkB/B;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,MAAM,CAAC,OAAO,GAAkB,EAAE;IAChD,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,aAAa,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAC7B,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE;YAC9B,KAAK,EAAE,UAAU,CAAC,KAAK;YACvB,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;YAC1C,UAAU,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC;SAC3D,CAAC;KACL,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAEnC,SAAS,WAAW,CAAC,KAAa;IAChC,MAAM,OAAO,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAC1C,IAAI,OAAO,CAAC,MAAM,IAAI,sBAAsB;QAAE,OAAO,OAAO,CAAC;IAC7D,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;AAC7E,CAAC;AAED;;;;GAIG;AACH,SAAS,aAAa,CAAC,GAAgB,EAAE,OAAuB,EAAE,GAAuB;IACvF,MAAM,MAAM,GAAuC;QACjD,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;QAClC,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,GAAG;KACJ,CAAC;IACF,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAC7D,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC,CAC7E,CAAC;IACF,OAAO,mBAAmB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC;AAClD,CAAC;AAED,SAAS,SAAS,CAAC,OAAuB;IACxC,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IACxB,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACxC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CACpB,GAAG,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,UAAU,SAAS,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC;AAC3H,CAAC;AAKD,SAAS,OAAO,CAAC,OAAuB;IACtC,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS;QAAE,OAAO,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,SAAS,wBAAwB,EAAE,CAAC;IACxG,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAChC,OAAO,EAAE,OAAO,EAAE,wEAAwE,EAAE,CAAC;IAC/F,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC;AACpE,CAAC;AAID,KAAK,UAAU,YAAY,CAAC,OAAuB,EAAE,IAAY,EAAE,IAAgB;IACjF,IAAI,OAAO,CAAC,eAAe,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC;IACzD,IAAI,CAAC;QACH,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,eAAe,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC;QAC5D,OAAO,SAAS,CAAC;IACnB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;IAC5E,CAAC;AACH,CAAC;AAED,4FAA4F;AAC5F,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,GAAgB,EAChB,MAAmB,EACnB,OAAsB,EACtB,IAAgB;IAEhB,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,IAAI,CAAC,CAAC;IAC1C,IAAI,OAAO,KAAK,SAAS;QAAE,OAAO,CAAC,EAAE,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,2CAA2C,EAAE,CAAC,CAAC;IAEhH,MAAM,KAAK,GAAmB,EAAE,YAAY,EAAE,OAAO,CAAC,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;IAC9F,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;IACpF,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9B,MAAM,MAAM,GAAG,aAAa,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IACxD,MAAM,IAAI,GACR,SAAS,IAAI,IAAI;QACf,CAAC,CAAC,eAAe,IAAI,CAAC,OAAO,GAAG,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,8BAA8B,CAAC,CAAC,CAAC,EAAE,EAAE;QAC7F,CAAC,CAAC,MAAM,aAAa,CAAC;YAClB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,MAAM;YACN,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,GAAG,IAAI;YACP,MAAM;YACN,IAAI,EAAE,aAAa,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,GAAG,KAAK,EAAE,MAAM,EAAE,CAAC;SACtD,CAAC,CAAC;IAET,OAAO;QACL,EAAE,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE;QACpC,GAAG,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,4BAA4B,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;KACvH,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@e2edev/github",
+  "version": "0.1.0",
+  "description": "GitHub reporter for e2e: one pull request comment per run, from GitHub Actions",
+  "keywords": [
+    "e2e",
+    "testing",
+    "agentic",
+    "end-to-end",
+    "reporter",
+    "github",
+    "github-actions",
+    "pull-request"
+  ],
+  "license": "MIT",
+  "contributors": [
+    "Oskar Kwaśniewski <oskar@tester.army>",
+    "Szymon Rybczak <szymon@tester.army>"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tester-army/e2e.git",
+    "directory": "packages/github"
+  },
+  "bugs": {
+    "url": "https://github.com/tester-army/e2e/issues"
+  },
+  "homepage": "https://github.com/tester-army/e2e/tree/main/packages/github#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "restricted",
+    "provenance": false,
+    "tag": "beta"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "@e2edev/e2e": ">=0.9.0 <1"
+  },
+  "devDependencies": {
+    "@types/node": "26.4.1",
+    "typescript": "7.0.2",
+    "vitest": "5.0.0",
+    "@e2edev/e2e": "0.10.0"
+  },
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "scripts": {
+    "build": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\" && tsc --project tsconfig.build.json",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:unit": "vitest run tests/unit"
+  }
+}