JamesIves
diff --git a/‎.github/copilot-instructions.md‎
Lines changed: 139 additions & 0 deletions b/‎.github/copilot-instructions.md‎
Lines changed: 139 additions & 0 deletions
diff --git a/‎.github/workflows/build.yml‎
Lines changed: 9 additions & 9 deletions b/‎.github/workflows/build.yml‎
Lines changed: 9 additions & 9 deletions
diff --git a/‎.github/workflows/deploy.yml‎
Lines changed: 1 addition & 1 deletion b/‎.github/workflows/deploy.yml‎
Lines changed: 1 addition & 1 deletion
diff --git a/‎.github/workflows/integration.yml‎
Lines changed: 14 additions & 14 deletions b/‎.github/workflows/integration.yml‎
Lines changed: 14 additions & 14 deletions
diff --git a/‎.github/workflows/label.yml‎
Lines changed: 2 additions & 2 deletions b/‎.github/workflows/label.yml‎
Lines changed: 2 additions & 2 deletions
diff --git a/‎.github/workflows/production.yml‎
Lines changed: 2 additions & 2 deletions b/‎.github/workflows/production.yml‎
Lines changed: 2 additions & 2 deletions
diff --git a/‎.github/workflows/sponsors.yml‎
Lines changed: 1 addition & 1 deletion b/‎.github/workflows/sponsors.yml‎
Lines changed: 1 addition & 1 deletion
diff --git a/‎.github/workflows/version.yml‎
Lines changed: 3 additions & 3 deletions b/‎.github/workflows/version.yml‎
Lines changed: 3 additions & 3 deletions
diff --git a/‎README.md‎
Lines changed: 1 addition & 1 deletion b/‎README.md‎
Lines changed: 1 addition & 1 deletion
@@ -0,0 +1,139 @@
+# GitHub Pages Deploy Action
+
+This is a GitHub Action that automatically deploys your project to GitHub Pages with GitHub Actions. The action can be configured to push your production-ready code into any branch you'd like, including `gh-pages` and `docs`. It supports cross-repository deployments, works with GitHub Enterprise, and provides multiple authentication methods including SSH keys and personal access tokens.
+
+Always follow these instructions first and only fallback to additional search and context gathering if the information in these instructions is incomplete or found to be in error.
+
+## Working Effectively
+
+### Bootstrap and build the repository:
+
+- Use Node.js version from `.node-version` file
+- Install Yarn globally: `npm install -g yarn`
+- Install dependencies: `yarn install --frozen-lockfile` -- takes 1-25 seconds depending on cache state
+- Build the project: `yarn build` -- takes 9 seconds. NEVER CANCEL. Set timeout to 30+ seconds
+- Run tests: `yarn test` -- takes 8 seconds. NEVER CANCEL. Set timeout to 30+ seconds
+- Check linting: `yarn lint:check` -- takes 3 seconds. Set timeout to 15+ seconds
+- Check formatting: `yarn lint:format:check` -- takes 2 seconds. Set timeout to 10+ seconds
+
+### Development workflow:
+
+- ALWAYS run the bootstrapping steps first (install dependencies and build)
+- Make code changes in the `src/` directory (TypeScript source)
+- Build with `yarn build` to compile TypeScript to JavaScript in `lib/` directory
+- Run `yarn test` to ensure tests pass
+- Run `yarn lint:check` and `yarn lint:format:check` before committing
+
+### Fix linting and formatting issues:
+
+- Auto-fix linting: `yarn lint`
+- Auto-format code: `yarn lint:format`
+
+## Validation
+
+### CRITICAL - Required validation steps:
+
+- ALWAYS run `yarn build` after making changes - the action depends on compiled JavaScript in `lib/`
+- ALWAYS run `yarn test` to ensure all unit tests pass
+- ALWAYS run `yarn lint:check` and `yarn lint:format:check` or the CI will fail
+- **NEVER CANCEL** any build or test commands - they complete quickly (under 30 seconds each)
+
+### Manual testing scenarios:
+
+Since this is a GitHub Action, full end-to-end testing requires deploying to a test repository. However, you can validate:
+
+- Unit tests cover core functionality: `yarn test` runs 59 tests with 92%+ coverage
+- Integration tests exist in `.github/workflows/integration.yml` but require GitHub Actions environment
+- Build output in `lib/` directory should match TypeScript source in `src/`
+
+### Before submitting changes:
+
+- Ensure all TypeScript compiles without errors: `yarn build`
+- Ensure all tests pass: `yarn test`
+- Ensure code follows style guidelines: `yarn lint:check` and `yarn lint:format:check`
+- The `lib/` directory must be committed for distribution branches (not for pull requests to `dev`)
+
+## Common Tasks
+
+### Repository structure:
+
+```
+src/               # TypeScript source files
+├── main.ts        # Entry point for GitHub Action
+├── lib.ts         # Main run function (can be used as module)
+├── constants.ts   # Configuration interfaces and constants
+├── git.ts         # Git operations for deployment
+├── util.ts        # Utility functions
+├── ssh.ts         # SSH key configuration
+├── execute.ts     # Command execution wrapper
+└── worktree.ts    # Git worktree operations
+
+__tests__/         # Jest test files
+lib/               # Compiled JavaScript (generated, do not edit)
+integration/       # Sample files for testing deployments
+.github/workflows/ # CI/CD workflows
+```
+
+### Key files and their purposes:
+
+- `action.yml` - GitHub Action definition with inputs/outputs
+- `package.json` - Dependencies and npm scripts
+- `tsconfig.json` - TypeScript compilation settings
+- `jest.config.js` - Test configuration
+- `eslint.config.mjs` - Linting rules (ignores `lib/` directory)
+- `.node-version` - Required Node.js version
+
+### Understanding the codebase:
+
+- **Entry Point**: `src/main.ts` imports and calls the `run()` function from `src/lib.ts`
+- **Core Logic**: `src/lib.ts` contains the main deployment logic
+- **Git Operations**: `src/git.ts` handles repository initialization and deployment
+- **Configuration**: `src/constants.ts` defines interfaces for action parameters
+- **Testing**: Comprehensive Jest tests in `__tests__/` directory with mocks for GitHub Actions
+
+### Common development patterns:
+
+- Action parameters are defined in `src/constants.ts` interfaces
+- Error handling uses try/catch with `extractErrorMessage()` utility
+- All git commands go through `execute()` wrapper for consistent logging
+- SSH and token authentication are handled in separate modules
+- Extensive parameter validation in `src/util.ts`
+
+### CI/CD behavior:
+
+- `.github/workflows/build.yml` runs on every push and PR
+- Linting, formatting, tests, and build must all pass
+- Integration tests deploy to test repositories using various authentication methods
+- Production releases include `node_modules` in distribution branches
+
+### Debugging and troubleshooting:
+
+- Check TypeScript compilation errors first: `yarn build`
+- Run specific test files: `yarn test <filename>`
+- Use `yarn lint` to auto-fix linting issues
+- The action supports debug mode via GitHub Actions debug logging
+- Integration tests in CI provide real deployment validation
+
+### Important notes:
+
+- The `lib/` directory is compiled output and should not be manually edited
+- Distribution branches (like `v4`) include `node_modules` and `lib/` for GitHub Actions runtime
+- The dev branch excludes `node_modules` and `lib/` from version control
+- SSH key support allows deployment with repository deploy keys
+- Cross-repository deployment is supported with proper token permissions
+
+### Environment requirements:
+
+- Node.js (specified in `.node-version`)
+- Yarn package manager
+- Git (for deployment operations)
+- rsync (for file operations, automatically available in GitHub Actions runners)
+
+### Performance expectations:
+
+- Fresh install: ~25 seconds for `yarn install --frozen-lockfile`
+- Cached install: ~1 second for `yarn install --frozen-lockfile`
+- Build: ~9 seconds for `yarn build`
+- Tests: ~8 seconds for `yarn test`
+- Linting: ~3 seconds for `yarn lint:check`
+- Formatting: ~2 seconds for `yarn lint:format:check`
@@ -14,9 +14,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5.0.0
 
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6.0.0
         with:
           node-version-file: '.node-version'
           registry-url: 'https://registry.npmjs.org'
@@ -32,17 +32,17 @@ jobs:
           yarn test
 
       - name: Uploade CodeCov Report
-        uses: codecov/codecov-action@v5.3.1
+        uses: codecov/codecov-action@v5.5.1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
 
   build:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5.0.0
 
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6.0.0
         with:
           node-version-file: '.node-version'
           registry-url: 'https://registry.npmjs.org'
@@ -61,7 +61,7 @@ jobs:
           ls node_modules
 
       - name: artifact
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v5.0.0
         with:
           name: dist
           path: |
@@ -78,17 +78,17 @@ jobs:
       max-parallel: 1
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5.0.0
         with:
           persist-credentials: false
 
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6.0.0
         with:
           node-version-file: '.node-version'
           registry-url: 'https://registry.npmjs.org'
 
       - name: Download artifact
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v6.0.0
         with:
           name: dist
 
 
@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5.0.0
 
       # Workflow dispatch event that pushes the current version to the release branch.
       # From here the secondary production deployment workflow will trigger to build the dependencies.
 
@@ -15,7 +15,7 @@ jobs:
           apt-get update && apt-get install -y rsync
 
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5.0.0
 
       - name: Build and Deploy
         uses: JamesIves/github-pages-deploy-action@v4
@@ -35,7 +35,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5.0.0
 
       - name: Build and Deploy
         uses: JamesIves/github-pages-deploy-action@v4
@@ -58,7 +58,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5.0.0
         with:
           persist-credentials: false
 
@@ -87,7 +87,7 @@ jobs:
         LANG: C.UTF-8
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5.0.0
         with:
           persist-credentials: false
 
@@ -116,7 +116,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5.0.0
         with:
           persist-credentials: false
 
@@ -142,12 +142,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5.0.0
         with:
           persist-credentials: false
 
       - name: Install SSH Client
-        uses: webfactory/[email protected].0
+        uses: webfactory/[email protected].1
         with:
           ssh-private-key: ${{ secrets.DEPLOY_KEY }}
 
@@ -172,11 +172,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5.0.0
         with:
           persist-credentials: false
 
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6.0.0
         with:
           node-version-file: '.node-version'
 
@@ -220,7 +220,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5.0.0
         with:
           persist-credentials: false
 
@@ -240,7 +240,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5.0.0
         with:
           persist-credentials: false
 
@@ -280,7 +280,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5.0.0
 
       - name: Create random file
         run: echo $RANDOM > integration/1
@@ -302,7 +302,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5.0.0
 
       - name: Create random file
         run: echo $RANDOM > integration/2
@@ -336,7 +336,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5.0.0
         with:
           persist-credentials: false
 
 
@@ -15,11 +15,11 @@ jobs:
     if: github.event.pull_request.merged == false
     steps:
       - name: Checkout 🛎️
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5.0.0
 
       - name: Assign Labels 🏷️
         id: action-assign-labels
-        uses: mauroalderete/action-assign-labels@v1
+        uses: mauroalderete/action-assign-labels@v1.5.1
         with:
           pull-request-number: ${{ github.event.pull_request.number }}
           github-token: ${{ secrets.GITHUB_TOKEN }}
 
@@ -13,9 +13,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5.0.0
 
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6.0.0
         with:
           node-version-file: '.node-version'
           registry-url: 'https://registry.npmjs.org'
 
@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎️
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5.0.0
 
       - name: Generate Sponsors 💖
         uses: JamesIves/github-sponsors-readme-action@v1
 
@@ -23,12 +23,12 @@ jobs:
     name: Publish to Registries 📦
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5.0.0
         with:
           ref: dev
 
       # Setup .npmrc file to publish to npm
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6.0.0
         with:
           node-version-file: '.node-version'
           registry-url: 'https://registry.npmjs.org'
@@ -59,7 +59,7 @@ jobs:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
       # Setup .npmrc file to publish to GitHub Packages
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6.0.0
         with:
           node-version-file: '.node-version'
           registry-url: 'https://npm.pkg.github.com'
 
@@ -21,7 +21,7 @@ Maintenance of this project is made possible by all the <a href="https://github.
 </p>
 
 <p align="center">
-<!-- premium --><a href="https://github.com/github"><img src="https://github.com/github.png" width="80px" alt="github" /></a>&nbsp;&nbsp;<a href="https://github.com/annegentle"><img src="https://github.com/annegentle.png" width="80px" alt="annegentle" /></a>&nbsp;&nbsp;<a href="https://github.com/tonjohn"><img src="https://github.com/tonjohn.png" width="80px" alt="tonjohn" /></a>&nbsp;&nbsp;<a href="https://github.com/"><img src="https://github.com/.png" width="80px" alt="" /></a>&nbsp;&nbsp;<!-- premium -->
+<!-- premium --><a href="https://github.com/github"><img src="https://github.com/github.png" width="80px" alt="github" /></a>&nbsp;&nbsp;<a href="https://github.com/annegentle"><img src="https://github.com/annegentle.png" width="80px" alt="annegentle" /></a>&nbsp;&nbsp;<a href="https://github.com/tonjohn"><img src="https://github.com/tonjohn.png" width="80px" alt="tonjohn" /></a>&nbsp;&nbsp;<a href="https://github.com/Zhenglei-BCS"><img src="https://github.com/Zhenglei-BCS.png" width="80px" alt="Zhenglei-BCS" /></a>&nbsp;&nbsp;<a href="https://github.com/"><img src="https://github.com/.png" width="80px" alt="" /></a>&nbsp;&nbsp;<!-- premium -->
 </p>
 
 <p align="center">