Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .changeset/merge-adapters-internal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
"@lytics/playwright-adapters": major
---

Merge `@lytics/playwright-adapters-internal` into `@lytics/playwright-adapters`

**Breaking Change:** The `@lytics/playwright-adapters-internal` package has been removed and merged into `@lytics/playwright-adapters`.

**Migration:**
- **Before:** `import { FirestoreAdapter } from '@lytics/playwright-adapters-internal/firestore';`
- **After:** `import { FirestoreAdapter } from '@lytics/playwright-adapters/firestore';`

All adapters (FilesystemAdapter, SlackAdapter, FirestoreAdapter) are now available in a single package, reducing maintenance overhead.
22 changes: 9 additions & 13 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,8 @@ A TypeScript monorepo providing reusable Playwright testing components built aro
packages/
├── annotations/ # Annotation framework (PUBLIC npm)
├── reporter/ # Core reporter (PUBLIC npm)
├── adapters/ # Generic adapters (PUBLIC npm)
├── adapters-internal/ # Firestore adapter (INTERNAL GitHub Packages)
└── journey/ # Journey tools (INTERNAL GitHub Packages)
├── adapters/ # Storage adapters (PUBLIC npm: filesystem, Slack, Firestore)
└── journey/ # Journey tools (PUBLIC npm)
```

### Package Details
Expand All @@ -33,9 +32,8 @@ packages/
|---------|-----------|---------|
| `@lytics/playwright-annotations` | Public npm | Annotation framework with validation |
| `@lytics/playwright-reporter` | Public npm | Adapter-based reporter |
| `@lytics/playwright-adapters` | Public npm | Generic adapters (filesystem, Slack) |
| `@lytics/playwright-adapters-internal` | GitHub Packages | Firestore adapter (Lytics schema) |
| `@lytics/playwright-journey` | GitHub Packages | Journey-driven test generation |
| `@lytics/playwright-adapters` | Public npm | Storage adapters (filesystem, Slack, Firestore) |
| `@lytics/playwright-journey` | Public npm | Journey-driven test generation |

## Setup Commands

Expand Down Expand Up @@ -84,7 +82,6 @@ Packages with dependencies must be built in order. Turborepo handles this automa
- `@lytics/playwright-annotations` - No dependencies (builds first)
- `@lytics/playwright-reporter` - Depends on annotations
- `@lytics/playwright-adapters` - Depends on reporter, annotations
- `@lytics/playwright-adapters-internal` - Depends on reporter, annotations
- `@lytics/playwright-journey` - Depends on annotations

**Critical:** Always run `pnpm build` before `pnpm typecheck` because TypeScript needs the built `.d.ts` files from dependencies.
Expand Down Expand Up @@ -219,9 +216,6 @@ pnpm changeset
- `@lytics/playwright-annotations`
- `@lytics/playwright-reporter`
- `@lytics/playwright-adapters`

**Internal packages** → GitHub Packages:
- `@lytics/playwright-adapters-internal`
- `@lytics/playwright-journey`

## Package Architecture
Expand All @@ -247,10 +241,12 @@ Generic storage adapters:
- `FilesystemAdapter` - Local JSON storage
- `SlackAdapter` - Slack notifications

### Adapters-Internal Package
### Adapters Package

Lytics-specific adapters:
- `FirestoreAdapter` - Firestore with Lytics schema
Storage adapters:
- `FilesystemAdapter` - Local JSON storage
- `SlackAdapter` - Slack notifications
- `FirestoreAdapter` - Google Cloud Firestore storage

### Journey Package

Expand Down
9 changes: 3 additions & 6 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,16 +119,13 @@ journey (depends on: annotations)
- Provides a pluggable architecture for different storage backends via adapters
- Collects and processes test results

3. **@lytics/playwright-adapters**: Generic storage adapters for the reporter.
3. **@lytics/playwright-adapters**: Storage adapters for the reporter.
- Filesystem adapter for storing results locally
- Slack adapter for notifications
- Firestore adapter for Google Cloud Firestore
- Implements common interfaces for storage backends

4. **@lytics/playwright-adapters-internal**: Internal adapters specific to Lytics/Contentstack.
- Firestore adapter with Lytics schema
- Internal implementation details

5. **@lytics/playwright-journey**: Journey-driven test generation.
4. **@lytics/playwright-journey**: Journey-driven test generation.
- Higher-level abstractions for journey-based testing
- Connects tests to user journeys and business requirements

Expand Down
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,13 @@ Open-source, generic infrastructure for any Playwright project:
|---------|-------------|---------|
| [`@lytics/playwright-annotations`](./packages/annotations) | Annotation framework with validation & ESLint | ![npm](https://img.shields.io/npm/v/@lytics/playwright-annotations) |
| [`@lytics/playwright-reporter`](./packages/reporter) | Adapter-based reporter with pluggable storage | ![npm](https://img.shields.io/npm/v/@lytics/playwright-reporter) |
| [`@lytics/playwright-adapters`](./packages/adapters) | Generic storage adapters (filesystem, Slack) | ![npm](https://img.shields.io/npm/v/@lytics/playwright-adapters) |
| [`@lytics/playwright-adapters`](./packages/adapters) | Storage adapters (filesystem, Slack, Firestore) | ![npm](https://img.shields.io/npm/v/@lytics/playwright-adapters) |

### Internal Packages (GitHub Packages)
### Contentstack-Specific Packages

Lytics/Contentstack-specific workflows:

| Package | Description |
|---------|-------------|
| [`@lytics/playwright-adapters-internal`](./packages/adapters-internal) | Firestore adapter with Lytics schema |
| [`@lytics/playwright-journey`](./packages/journey) | Journey-driven test generation |
| Package | Description | Version |
|---------|-------------|---------|
| [`@lytics/playwright-journey`](./packages/journey) | Journey-driven test generation | ![npm](https://img.shields.io/npm/v/@lytics/playwright-journey) |

## 🚀 Quick Start

Expand Down
42 changes: 0 additions & 42 deletions docs/RELEASE_PROCESS.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,48 +61,6 @@ Packages without `publishConfig` are published to npm:
}
```

### Internal Packages (GitHub Packages)

Packages with `registry` configured are published to GitHub Packages:

```json
{
"name": "@lytics/playwright-adapters-internal",
"publishConfig": {
"registry": "https://npm.pkg.github.com",
"access": "restricted"
}
}
```

## Installing Internal Packages

To install packages from GitHub Packages, configure npm authentication:

### Option 1: Using GITHUB_TOKEN (CI/CD)

```bash
# In your CI/CD environment
echo "@lytics:registry=https://npm.pkg.github.com" >> .npmrc
echo "//npm.pkg.github.com/:_authToken=$GITHUB_TOKEN" >> .npmrc
```

### Option 2: Using Personal Access Token (Local)

Create `.npmrc` in your project:

```
@lytics:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=YOUR_PERSONAL_ACCESS_TOKEN
```

**Note:** Add `.npmrc` to `.gitignore` if it contains tokens!

Then install:

```bash
npm install @lytics/playwright-adapters-internal
```

## Versioning Guidelines

Expand Down
25 changes: 0 additions & 25 deletions packages/adapters-internal/CHANGELOG.md

This file was deleted.

Loading