⚙️ Configuration Options — GitHub Action for Pull Requests

This page lists all configuration inputs and behavior for the Early-Catch GitHub Action on pull requests.

For shared concepts like tokens, memory, linting, concurrency, and SCM setup, see:

• NPM Installation
• Token Permissions
• SCM Support
• Memory Tuning
• Linting & Formatting
• Concurrency

---

🔑 Required Inputs

JavaScript / TypeScript

Name	Description	Required	Default
api-key	Early AI API key for backend access.	✅ Yes	–
token	GitHub token for repo access and commits. See token docs.	✅ Yes	GITHUB_TOKEN

Python

Variable	Description	Required	Default
API_KEY	Early AI API key for backend access.	✅ Yes	–
TOKEN	GitHub token for repo access and commits. See token docs.	✅ Yes	–
PR_NUMBER	Pull request number.	✅ Yes	–
REF_NAME	PR branch name.	✅ Yes	–

Note: Python uses the Early CLI directly (not the GitHub Marketplace action), so environment variables are used instead of action with: inputs.

---

⚙️ Optional Inputs

JavaScript / TypeScript

Name	Description	Default
test-structure	Where to place tests: siblingFolder or rootFolder	siblingFolder
test-framework	Target test framework (jest only for now)	jest
test-file-suffix	Suffix like test or spec	test
test-file-naming	camelCase, kebabCase, etc.	camelCase
max-concurrency	1–4 workers. See concurrency guide.	1
auto-commit	true/false — whether to push files automatically	true
changed-methods-only	true/false — Generate tests only for changed methods	false
coverage-command	Custom coverage command — must keep Early flags	See Agent Jest Commands →
test-command	Custom validation command — must keep Early flags	See Agent Jest Commands →
continue-on-test-errors	continue the operation if current tests fail.	See Agent Jest Commands - tests fail →
lint-command	ESLint command before commit (see lint guide)	npx --no eslint $early_filename --fix
prettier-command	Prettier command before commit (see format guide)	npx --no prettier $early_filename --write

Python

Variable	Description	Default
TEST_FRAMEWORK	Test framework. Auto-set to pytest for Python.	pytest
TEST_STRUCTURE	Folder structure: siblingFolder or rootFolder.	siblingFolder
TEST_FILE_NAMING	Naming style: camelCase or kebabCase.	camelCase
MAX_TESTABLES	Max number of methods to generate tests for.	5
MAX_CONCURRENCY	Parallel workers (1–3).	3
AUTO_COMMIT	Commit and push generated test files: true or false.	true
AUTO_COMMIT_SKIP_CI	Append [skip ci] to the auto-commit message.	true
GIT_USER_EMAIL	Commit author email.	Early-Agent[bot] noreply address
GIT_USER_NAME	Commit author name.	early-agent[bot]
SCM_PROVIDER	github or bitbucket.	github

Note: Options like --test-command, --coverage-command, --lint-command, and --prettier-command are not yet supported for Python.

---

📤 Outputs

Output Name	Description
pre-coverage	Coverage before test generation
post-coverage	Coverage after test generation

Note: Coverage outputs are currently available for JavaScript/TypeScript projects only.

---

🧠 Memory Recommendation

JavaScript / TypeScript

Set this in the env: section of your job:

NODE_OPTIONS: "--max-old-space-size=5120"

Required when using default concurrency (4). See Memory Tuning for limits per runner.

Python

Python test generation does not require NODE_OPTIONS memory tuning. The py-agent manages its own memory usage.

---

📂 Placement: test-structure

JavaScript / TypeScript

• siblingFolder → test files placed next to source
• rootFolder → test files placed under a root /tests folder

Python

Test files are placed in .early.test/ sibling folders next to the source file:

src/
  utils/
    helpers.py
    helpers.early.test/
      test_my_function_early.py

---

🧪 Framework: test-framework

JavaScript / TypeScript

Currently only jest is supported. Support for mocha and vitest is planned.

Python

The test framework is automatically set to pytest for Python projects. No configuration is needed.

---

🧹 Lint & Format Commands

JavaScript / TypeScript

If your repository enforces code style, prettier formatting, or pre-commit linting, you may need to configure test generation agents to run those tools automatically.

Early CLI agents have built-in defaults for linting and formatting:

lint-command: npx --no eslint $early_filename --fix
prettier-command: npx --no prettier $early_filename --write

These are the same commands described below. If your repository uses different commands (e.g., via hooks or custom scripts), you should override these defaults accordingly.

Python

Lint and formatting hooks are not yet supported for Python projects. Generated test files follow standard pytest conventions.

---

🧠 Advanced Commands

If customizing test or coverage commands, you must keep all required Early flags.

TBD

---

🔔 Recommended Triggers

We recommend:

• opened — when PR is first created
• ready_for_review — when draft is finalized

Avoid push or synchronize unless you want re-generation on every commit.

---

🧩 Example Configuration Block

JavaScript / TypeScript

with:
  api-key: ${{ secrets.EARLY_SECRET_TOKEN }}
  token: ${{ secrets.GITHUB_TOKEN }}
  test-framework: jest
  test-structure: rootFolder
  test-file-suffix: spec
  test-file-naming: kebabCase
  auto-commit: true
  lint-command: npx --no eslint $early_filename --fix
  prettier-command: npx --no prettier $early_filename --write

Python

env:
  API_KEY: ${{ secrets.EARLY_API_KEY }}
  TOKEN: ${{ secrets.GITHUB_TOKEN }}
  PR_NUMBER: ${{ github.event.pull_request.number }}
  REF_NAME: ${{ github.head_ref }}
  BASE_REF: ${{ github.base_ref }}
  TEST_FRAMEWORK: pytest
  MAX_CONCURRENCY: "3"
  AUTO_COMMIT: "true"

---

✅ Best Practices

• Keep auto-commit enabled — only valid files are pushed
• Always define NODE_OPTIONS for JavaScript/TypeScript projects
• Use lint-command and prettier-command to prevent CI/pre-commit errors (JS/TS only)
• Tune max-concurrency if hitting memory limits

---

👉 Next: Troubleshooting