Skip to content

Commit c6c5cca

Browse files
committed
Update README to clarify recommended workflow
1 parent dbfede4 commit c6c5cca

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

‎.github/workflows/README.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This project uses GitHub Actions for CI/CD. You can run these workflows locally
44

55
## Workflow Overview
66

7-
### Main Workflow: `tests.yml`
7+
### Main Workflow: `tests.yml` ⭐ **RECOMMENDED**
88
**Primary workflow for all tests and linting**
99
- Runs on: `push` and `pull_request` to `main` and `develop`
1010
- Jobs:
@@ -13,16 +13,17 @@ This project uses GitHub Actions for CI/CD. You can run these workflows locally
1313
- `frontend-lint` - Lints TypeScript/JavaScript frontend code
1414
- `backend-tests` - Runs backend unit and integration tests (Python 3.11, 3.12, 3.13)
1515
- `frontend-tests` - Runs frontend type checking
16-
- `e2e-tests` - Runs end-to-end tests with Playwright
16+
- `e2e-tests` - Runs end-to-end tests with Playwright (includes proper dependency installation)
1717
- `build` - Builds the frontend application
1818

1919
**Use this workflow for:**
20-
- Full CI/CD pipeline
21-
- Comprehensive testing
22-
- Pull request validation
20+
- ✅ Full CI/CD pipeline
21+
- ✅ Comprehensive testing
22+
- ✅ Pull request validation
23+
- ✅ **E2E tests (properly configured with dependencies)**
2324

2425
### Secondary Workflow: `e2e-tests.yml`
25-
**Standalone E2E test workflow**
26+
**Standalone E2E test workflow (legacy/alternative)**
2627
- Runs on: `push`, `pull_request` to `main` and `develop`, and `workflow_dispatch`
2728
- Single job: `e2e` - Runs only E2E tests
2829

@@ -31,7 +32,7 @@ This project uses GitHub Actions for CI/CD. You can run these workflows locally
3132
- Manual E2E testing via workflow_dispatch
3233
- Focused E2E test debugging
3334

34-
**Note:** The main `tests.yml` workflow is recommended for most use cases as it includes all tests and linting.
35+
**Note:** The main `tests.yml` workflow is **recommended** for most use cases as it includes all tests, linting, and properly configured E2E tests with dependency installation.
3536

3637
## Prerequisites
3738

0 commit comments

Comments
 (0)