fix: drop dependency upon @actions/github to get the context. (#2594)

Signed-off-by: Jason Dent <Jason3S@users.noreply.github.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: 3 people

action-src/package.json

@@ -21,7 +21,6 @@
     "@cspell/cspell-bundled-dicts"
   ],
   "devDependencies": {
-    "@actions/github": "^8.0.0",
     "@cspell/cspell-types": "^9.6.2",
     "@octokit/webhooks-types": "^7.6.1",
     "@types/node": "^24.10.9",

action-src/src/action.test.ts

@@ -1,9 +1,10 @@
-import { Context } from '@actions/github/lib/context.js';
-import * as path from 'path';
-import * as process from 'process';
+import * as path from 'node:path';
+import * as process from 'node:process';
+
 import { beforeEach, describe, expect, test, vi } from 'vitest';
 
 import { action } from './action.js';
+import { Context } from './actions/github/index.js';
 import { AppError } from './error.js';
 import { fetchGithubActionFixture, root, sourceDir } from './test/helper.js';
 

action-src/src/action.ts

@@ -1,10 +1,10 @@
 import path from 'node:path';
 
-import type { Context as GitHubContext } from '@actions/github/lib/context.js';
 import type { RunResult } from 'cspell';
 
 import { validateActionParams } from './ActionParams.js';
 import { debug, error, info, setFailed, setOutput, warning } from './actions/core/index.js';
+import type { Context as GitHubContext } from './actions/github/index.js';
 import { checkDotMap } from './checkDotMap.js';
 import { checkSpellingForContext, type Context } from './checkSpelling.js';
 import { getActionParams } from './getActionParams.js';

action-src/src/actions/github/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright 2019 GitHub
+
+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.

action-src/src/actions/github/README.md

@@ -0,0 +1,3 @@
+# @action/github
+
+This is a pared down version of GitHub's [@actions/github](https://github.com/actions/toolkit/tree/dfc20ac/packages/github)

action-src/src/actions/github/context.test.ts

@@ -0,0 +1,82 @@
+import path from 'node:path';
+
+import { describe, expect, test, vi } from 'vitest';
+
+import { fetchGithubActionFixture, root } from '../../test/helper.js';
+
+const configFile = path.resolve(root, 'cspell.json');
+
+import { Context } from './context.js';
+
+describe('Context', () => {
+    test('Context', () => {
+        createContextEnvFromFile('pull_request.json');
+        const context = new Context();
+        expect(context.eventName).toBe('pull_request');
+        expect(context.sha).toBe('fac78ee45538f198c00ae651db5aedc7336f7ccc');
+    });
+
+    test('Context no event path', () => {
+        createContextEnvFromFile('pull_request.json');
+        process.env.GITHUB_EVENT_PATH = '';
+        const context = new Context();
+        expect(context.eventName).toBe('pull_request');
+        expect(context.sha).toBe('fac78ee45538f198c00ae651db5aedc7336f7ccc');
+    });
+
+    test('Context bad event path', () => {
+        process.env.GITHUB_EVENT_PATH = './non/existent/path.json';
+        const stdoutSpy = vi.spyOn(process.stdout, 'write').mockImplementation(() => true);
+        expect(() => new Context()).not.toThrow();
+        expect(stdoutSpy).toHaveBeenCalledWith('GITHUB_EVENT_PATH ./non/existent/path.json does not exist\n');
+    });
+
+    test('Context.issue', () => {
+        createContextEnvFromFile('pull_request.json');
+        const context = new Context();
+        expect(context.issue).toEqual({ number: 3, owner: 'streetsidesoftware', repo: 'cspell-action' });
+    });
+
+    test('Context.issue with non-issue', () => {
+        process.env.GITHUB_EVENT_PATH = '';
+        process.env.GITHUB_REPOSITORY = 'some-owner/some-repo';
+        const context = new Context();
+        expect(context.issue).toEqual({ number: undefined, owner: 'some-owner', repo: 'some-repo' });
+    });
+
+    test('Context.repo', () => {
+        createContextEnvFromFile('pull_request.json');
+        process.env.GITHUB_REPOSITORY = '';
+        const context = new Context();
+        expect(context.repo).toEqual({ owner: 'streetsidesoftware', repo: 'cspell-action' });
+
+        process.env.GITHUB_REPOSITORY = 'some-owner/some-repo';
+        expect(context.repo).toEqual({ owner: 'some-owner', repo: 'some-repo' });
+    });
+
+    test('Context.repo error', () => {
+        process.env.GITHUB_EVENT_PATH = '';
+        process.env.GITHUB_REPOSITORY = '';
+        const context = new Context();
+        expect(() => context.repo).toThrow(
+            "context.repo requires a GITHUB_REPOSITORY environment variable like 'owner/repo'",
+        );
+    });
+});
+
+function createContextEnvFromFile(filename: string, ...params: Record<string, string>[]): void {
+    return createContext(fetchGithubActionFixture(filename), ...params);
+}
+
+function createContext(...params: Record<string, string>[]): void {
+    Object.assign(process.env, ...params);
+    setEnvIfNotExist('INPUT_ROOT', root);
+    setEnvIfNotExist('INPUT_CONFIG', configFile);
+    process.env.INPUT_CONFIG = path.resolve(root, process.env.INPUT_CONFIG || configFile);
+}
+
+function setEnvIfNotExist(key: string, value: string) {
+    if (process.env[key] === undefined) {
+        process.env[key] = value;
+    }
+}

action-src/src/actions/github/context.ts

@@ -0,0 +1,80 @@
+// Copied from:
+// https://github.com/actions/toolkit/blob/ecdfc18bf2ccf0651026d5a34ede173cf2c85e9d/packages/github/src/context.ts
+import { existsSync, readFileSync } from 'fs';
+import { EOL } from 'os';
+
+import { WebhookPayload } from './interfaces.js';
+
+export class Context {
+    /**
+     * Webhook payload object that triggered the workflow
+     */
+    payload: WebhookPayload;
+
+    eventName: string;
+    sha: string;
+    ref: string;
+    workflow: string;
+    action: string;
+    actor: string;
+    job: string;
+    runAttempt: number;
+    runNumber: number;
+    runId: number;
+    apiUrl: string;
+    serverUrl: string;
+    graphqlUrl: string;
+
+    /**
+     * Hydrate the context from the environment
+     */
+    constructor() {
+        this.payload = {};
+        if (process.env.GITHUB_EVENT_PATH) {
+            if (existsSync(process.env.GITHUB_EVENT_PATH)) {
+                this.payload = JSON.parse(readFileSync(process.env.GITHUB_EVENT_PATH, { encoding: 'utf8' }));
+            } else {
+                const path = process.env.GITHUB_EVENT_PATH;
+                process.stdout.write(`GITHUB_EVENT_PATH ${path} does not exist${EOL}`);
+            }
+        }
+        this.eventName = process.env.GITHUB_EVENT_NAME as string;
+        this.sha = process.env.GITHUB_SHA as string;
+        this.ref = process.env.GITHUB_REF as string;
+        this.workflow = process.env.GITHUB_WORKFLOW as string;
+        this.action = process.env.GITHUB_ACTION as string;
+        this.actor = process.env.GITHUB_ACTOR as string;
+        this.job = process.env.GITHUB_JOB as string;
+        this.runAttempt = parseInt(process.env.GITHUB_RUN_ATTEMPT as string, 10);
+        this.runNumber = parseInt(process.env.GITHUB_RUN_NUMBER as string, 10);
+        this.runId = parseInt(process.env.GITHUB_RUN_ID as string, 10);
+        this.apiUrl = process.env.GITHUB_API_URL ?? `https://api.github.com`;
+        this.serverUrl = process.env.GITHUB_SERVER_URL ?? `https://github.com`;
+        this.graphqlUrl = process.env.GITHUB_GRAPHQL_URL ?? `https://api.github.com/graphql`;
+    }
+
+    get issue(): { owner: string; repo: string; number: number } {
+        const payload = this.payload;
+
+        return {
+            ...this.repo,
+            number: (payload.issue || payload.pull_request || payload).number,
+        };
+    }
+
+    get repo(): { owner: string; repo: string } {
+        if (process.env.GITHUB_REPOSITORY) {
+            const [owner, repo] = process.env.GITHUB_REPOSITORY.split('/');
+            return { owner, repo };
+        }
+
+        if (this.payload.repository) {
+            return {
+                owner: this.payload.repository.owner.login,
+                repo: this.payload.repository.name,
+            };
+        }
+
+        throw new Error("context.repo requires a GITHUB_REPOSITORY environment variable like 'owner/repo'");
+    }
+}

action-src/src/actions/github/index.ts

@@ -0,0 +1 @@
+export { Context } from './context.js';

action-src/src/actions/github/interfaces.ts

@@ -0,0 +1,46 @@
+// Copied from:
+// https://github.com/actions/toolkit/blob/ecdfc18bf2ccf0651026d5a34ede173cf2c85e9d/packages/github/src/interfaces.ts
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+export interface PayloadRepository {
+    [key: string]: any;
+    full_name?: string;
+    name: string;
+    owner: {
+        [key: string]: any;
+        login: string;
+        name?: string;
+    };
+    html_url?: string;
+}
+
+export interface WebhookPayload {
+    [key: string]: any;
+    repository?: PayloadRepository;
+    issue?: {
+        [key: string]: any;
+        number: number;
+        html_url?: string;
+        body?: string;
+    };
+    pull_request?: {
+        [key: string]: any;
+        number: number;
+        html_url?: string;
+        body?: string;
+    };
+    sender?: {
+        [key: string]: any;
+        type: string;
+    };
+    action?: string;
+    installation?: {
+        id: number;
+        [key: string]: any;
+    };
+    comment?: {
+        id: number;
+        [key: string]: any;
+    };
+}

action-src/src/main.ts

@@ -1,7 +1,6 @@
-import { Context } from '@actions/github/lib/context.js';
-
 import { action } from './action.js';
 import { info, setFailed } from './actions/core/index.js';
+import { Context } from './actions/github/index.js';
 import { toError } from './error.js';
 
 export async function run(): Promise<undefined | Error> {