feat: add test-e2e job to ci workflow and example script

Author: tkstang

.github/scripts/example.ts

@@ -0,0 +1,94 @@
+import {
+  createStickyComment,
+  findCommentByIdentifier,
+  addLabelsToPullRequest,
+  pullRequestHasLabels,
+  getCurrentPullRequestNumber,
+  getRepoInfo,
+  sanitizeInput,
+  escapeMarkdown,
+  formatDate,
+  checkBranchExists,
+  listDeployments,
+} from "github-typescript-utils";
+
+type Ctx = {
+  core: typeof import("@actions/core");
+  github: ReturnType<typeof import("@actions/github").getOctokit>;
+  context: typeof import("@actions/github").context;
+  args: {
+    testMessage: string;
+    testLabels: string[];
+    testBranch: string;
+  };
+};
+
+/**
+ * E2E test script that exercises various utility functions
+ * to verify they can be imported and bundled correctly
+ */
+export default async function run({ core, github, context, args }: Ctx) {
+  core.info("🚀 Starting E2E test of github-typescript-utils");
+
+  try {
+    // Test 1: Input sanitization
+    const sanitizedMessage = sanitizeInput(args.testMessage);
+    core.info(
+      `✅ Input sanitization: "${args.testMessage}" → "${sanitizedMessage}"`
+    );
+
+    // Test 2: Text formatting utilities
+    const escapedText = escapeMarkdown("**Bold** _italic_ `code`");
+    const formattedDate = formatDate(new Date());
+    core.info(
+      `✅ Text formatting: escaped="${escapedText}", date="${formattedDate}"`
+    );
+
+    // Test 3: Context utilities
+    const repoInfo = getRepoInfo(context);
+    core.info(`✅ Repo info: ${repoInfo.owner}/${repoInfo.repo}`);
+
+    // Test 4: PR context (if available)
+    const prNumber = getCurrentPullRequestNumber(context);
+    if (prNumber) {
+      core.info(`✅ PR context: Found PR #${prNumber}`);
+
+      // Test PR utilities
+      const hasLabels = await pullRequestHasLabels({
+        ctx: { core, github, context },
+        repo: repoInfo,
+        pullNumber: prNumber,
+        labels: args.testLabels,
+      });
+      core.info(
+        `✅ PR label check: has labels [${args.testLabels.join(
+          ", "
+        )}] = ${hasLabels}`
+      );
+    } else {
+      core.info("ℹ️ No PR context available, skipping PR-specific tests");
+    }
+
+    // Test 5: Branch utilities
+    const branchExists = await checkBranchExists({
+      ctx: { core, github, context },
+      repo: repoInfo,
+      branchName: args.testBranch,
+    });
+    core.info(`✅ Branch check: "${args.testBranch}" exists = ${branchExists}`);
+
+    core.info("🎉 E2E test completed successfully!");
+
+    return {
+      success: true,
+      testsRun: 7,
+      repoInfo,
+      prNumber,
+      branchExists,
+    };
+  } catch (error) {
+    core.error(`❌ E2E test failed: ${error}`);
+    core.setFailed(`E2E test failed: ${error}`);
+    return { success: false, error: String(error) };
+  }
+}

.github/scripts/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@tkstang/ci-scripts",
+  "private": true,
+  "type": "module",
+  "dependencies": {
+    "github-typescript-utils": "file:../../"
+  }
+}

.github/workflows/ci.yml

@@ -36,6 +36,7 @@ jobs:
 
   test:
     name: Test Suite
+    needs: lint
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -90,10 +91,53 @@ jobs:
           echo "" >> $GITHUB_STEP_SUMMARY
           echo "✅ **${TEST_COUNT} tests passed** with **${OVERALL_COVERAGE} overall coverage**" >> $GITHUB_STEP_SUMMARY
 
+  test-e2e:
+    name: E2E Test with github-typescript
+    needs: lint
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+      deployments: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: pnpm
+
+      # Install scripts dependencies (including local utils via file:../../)
+      - name: Setup scripts dependencies
+        run: |
+          cd .github/scripts
+          pnpm install
+
+      # Run the example script through the published wrapper
+      - name: Run E2E test via github-typescript
+        uses: tkstang/github-typescript@v1
+        with:
+          working-directory: .github/scripts
+          ts-file: example.ts
+          node-version: "22"
+          args: |
+            {
+              "testMessage": "Hello E2E Test!",
+              "testLabels": ["e2e-test", "automated"],
+              "testBranch": "main"
+            }
+
   build:
     name: Build
     runs-on: ubuntu-latest
-    needs: [lint, test]
+    needs: [lint, test, test-e2e]
     steps:
       - name: Checkout
         uses: actions/checkout@v4

README.md

@@ -52,6 +52,70 @@ yarn add github-typescript-utils
 
 ## Usage with github-typescript
 
+### Dependency Setup
+
+For `esbuild` to resolve `github-typescript-utils`, you need the package available in `node_modules`. Choose one approach:
+
+#### Option A: Root Dependencies (Simplest)
+
+Add to your repository's root `package.json`:
+
+```json
+{
+  "dependencies": {
+    "github-typescript-utils": "^0.2.0"
+  }
+}
+```
+
+Workflow setup:
+
+```yaml
+- uses: actions/setup-node@v4
+  with:
+    node-version: 22
+    cache: pnpm
+- run: pnpm install
+
+- uses: tkstang/github-typescript@v1
+  with:
+    ts-file: .github/scripts/manage-pr.ts
+```
+
+#### Option B: Isolated CI Dependencies
+
+Create `.github/scripts/package.json`:
+
+```json
+{
+  "name": "ci-scripts",
+  "private": true,
+  "type": "module",
+  "dependencies": {
+    "github-typescript-utils": "^0.2.0"
+  }
+}
+```
+
+Workflow setup:
+
+```yaml
+- uses: actions/setup-node@v4
+  with:
+    node-version: 22
+    cache: pnpm
+    cache-dependency-path: .github/scripts/pnpm-lock.yaml
+- run: pnpm install
+  working-directory: .github/scripts
+
+- uses: tkstang/github-typescript@v1
+  with:
+    working-directory: .github/scripts
+    ts-file: manage-pr.ts
+```
+
+### Script Example
+
 Create a TypeScript script that imports the utilities:
 
 ```ts