@ihyeon/flow-qa 0.1.0-alpha.3 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.ko.md +6 -4
  2. package/README.md +5 -3
  3. package/docs/architecture.md +1 -1
  4. package/docs/releases.md +43 -3
  5. package/docs/ui.md +2 -2
  6. package/package.json +2 -2
package/README.ko.md CHANGED
@@ -1,20 +1,22 @@
1
1
  # Flow QA
2
2
 
3
+ [![npm 버전](https://img.shields.io/npm/v/%40ihyeon%2Fflow-qa?label=npm)](https://www.npmjs.com/package/@ihyeon/flow-qa) · [npm 패키지: @ihyeon/flow-qa](https://www.npmjs.com/package/@ihyeon/flow-qa)
4
+
3
5
  [English](https://github.com/hyeonse-swing/flow-qa/blob/main/README.md) · **한국어**
4
6
 
5
7
  사용자 플로우를 검토 가능한 테스트 케이스로 바꾸고, 실제 브라우저 실행 결과를 증거가 연결된 QA 리포트로 남기는 로컬 도구입니다. 플로우의 기대 결과가 모호하면 추측해 통과시키지 않고 질문과 차단 상태로 남깁니다.
6
8
 
7
- **공개 알파:** CLI와 `127.0.0.1` 전용 웹 UI를 제공합니다. UI는 영어로 시작하며 상단 언어 전환에서 한국어를 선택할 수 있습니다. 선택은 이 브라우저에 저장됩니다. 테스트 대상의 URL과 화면 계약을 사용하며 앱 소스 또는 데이터베이스 접근은 필수가 아닙니다. 설치 없이 구조를 보려면 [아키텍처](https://github.com/hyeonse-swing/flow-qa/blob/main/docs/architecture.md)와 [UI 안내](https://github.com/hyeonse-swing/flow-qa/blob/main/docs/ui.md)를 참고하세요.
9
+ CLI와 `127.0.0.1` 전용 웹 UI를 제공합니다. UI는 영어로 시작하며 상단 언어 전환에서 한국어를 선택할 수 있습니다. 선택은 이 브라우저에 저장됩니다. 테스트 대상의 URL과 화면 계약을 사용하며 앱 소스 또는 데이터베이스 접근은 필수가 아닙니다. 설치 없이 구조를 보려면 [아키텍처](https://github.com/hyeonse-swing/flow-qa/blob/main/docs/architecture.md)와 [UI 안내](https://github.com/hyeonse-swing/flow-qa/blob/main/docs/ui.md)를 참고하세요.
8
10
 
9
11
  ![로컬 데모 화면](https://raw.githubusercontent.com/hyeonse-swing/flow-qa/main/docs/media/flow-qa-demo.png)
10
12
 
11
13
 
12
14
  ## 로컬 데모 시작
13
15
 
14
- Node.js 24 이상이 필요합니다. 패키지는 `@ihyeon/flow-qa@0.1.0-alpha.3`입니다. 브라우저는 첫 실행 전에 설치합니다.
16
+ Node.js 24 이상이 필요합니다. 브라우저는 첫 실행 전에 설치합니다.
15
17
 
16
18
  ```sh
17
- npm install -g @ihyeon/flow-qa@0.1.0-alpha.3
19
+ npm install -g @ihyeon/flow-qa@0.1.2
18
20
  flow-qa browser install
19
21
  flow-qa ui --demo
20
22
  ```
@@ -64,7 +66,7 @@ flow-qa plan flows/my-flow.md --workspace my-qa
64
66
  - 실행마다 `.flowqa/runs/<run-id>/`에 새 리포트와 엔진 결과를 만듭니다. `qa-report.json`과 `qa-report.md`는 통과, 실패, 재시도 후 통과, 차단, 오류, 미실행을 구분합니다. assertion 실패는 관찰 결과이며 제품 버그 확정은 아닙니다.
65
67
  - 취소한 실행은 중단으로 기록합니다. UI의 생성 취소는 늦게 도착한 응답을 반영하지 않지만 모델 제공자의 처리나 과금 취소를 보장하지 않습니다. 엔진의 토큰·추정 비용만 표시하며 전체 비용 상한은 없습니다.
66
68
 
67
- 리포트와 원본 증거에는 테스트 앱의 데이터가 포함될 수 있습니다. `.flowqa/`는 Git에서 제외되지만 외부 공유 전에는 내용을 확인하세요. 마스킹이 모든 개인정보를 탐지한다고 보장하지 않습니다. 세션 준비, 모바일 기기, 예약 CI 실행, 팀 권한과 공유 서버는 이 알파의 지원 범위 밖입니다.
69
+ 리포트와 원본 증거에는 테스트 앱의 데이터가 포함될 수 있습니다. `.flowqa/`는 Git에서 제외되지만 외부 공유 전에는 내용을 확인하세요. 마스킹이 모든 개인정보를 탐지한다고 보장하지 않습니다. 세션 준비, 모바일 기기, 예약 CI 실행, 팀 권한과 공유 서버는 현재 지원 범위에 포함되지 않습니다.
68
70
 
69
71
  ![실제 세 케이스 실행 결과](https://raw.githubusercontent.com/hyeonse-swing/flow-qa/main/docs/media/flow-qa-report.png)
70
72
 
package/README.md CHANGED
@@ -1,10 +1,12 @@
1
1
  # Flow QA
2
2
 
3
+ [![npm version](https://img.shields.io/npm/v/%40ihyeon%2Fflow-qa?label=npm)](https://www.npmjs.com/package/@ihyeon/flow-qa) · [npm package: @ihyeon/flow-qa](https://www.npmjs.com/package/@ihyeon/flow-qa)
4
+
3
5
  **English** · [한국어](https://github.com/hyeonse-swing/flow-qa/blob/main/README.ko.md)
4
6
 
5
7
  Flow QA turns a user flow into reviewable test cases, runs them in a real browser, and ties the results to evidence in a QA report. When an expected outcome is unclear, it keeps the question visible and blocks that case instead of guessing.
6
8
 
7
- **Public alpha:** a CLI and a web UI bound to `127.0.0.1`. Provide a target URL and describe the screen behavior; access to the application's source code or database is optional. The UI starts in English. Use the language switch in the top bar for Korean; the choice is saved in this browser. See the [architecture](https://github.com/hyeonse-swing/flow-qa/blob/main/docs/architecture.md) and [UI guide](https://github.com/hyeonse-swing/flow-qa/blob/main/docs/ui.md) for the details.
9
+ Flow QA is available as a CLI and a web UI bound to `127.0.0.1`. Provide a target URL and describe the screen behavior; access to the application's source code or database is optional. The UI starts in English. Use the language switch in the top bar for Korean; the choice is saved in this browser. See the [architecture](https://github.com/hyeonse-swing/flow-qa/blob/main/docs/architecture.md) and [UI guide](https://github.com/hyeonse-swing/flow-qa/blob/main/docs/ui.md) for the details.
8
10
 
9
11
  ![Flow QA local demo](https://raw.githubusercontent.com/hyeonse-swing/flow-qa/main/docs/media/flow-qa-demo.png)
10
12
 
@@ -14,7 +16,7 @@ Flow QA turns a user flow into reviewable test cases, runs them in a real browse
14
16
  Requires Node.js 24 or later. Install Chromium before the first run:
15
17
 
16
18
  ```sh
17
- npm install -g @ihyeon/flow-qa@0.1.0-alpha.3
19
+ npm install -g @ihyeon/flow-qa@0.1.2
18
20
  flow-qa browser install
19
21
  flow-qa ui --demo
20
22
  ```
@@ -64,7 +66,7 @@ For authenticated models, add `--key-env FLOW_QA_API_KEY` to the model command a
64
66
  - Each run gets a fresh `.flowqa/runs/<run-id>/` directory with engine output and `qa-report.json`/`qa-report.md`. Reports distinguish passed, failed, passed after retry, blocked, error, and skipped cases. A failed assertion is an observation, not proof of a product defect.
65
67
  - Cancellation records an interrupted run. Canceling generation prevents a late response from changing the draft, but does not guarantee cancellation of a provider's processing or charges. The UI shows token use and estimated cost only when the engine supplies them; there is no overall cost cap.
66
68
 
67
- Reports and raw evidence can contain data from the tested app. `.flowqa/` is Git-ignored, but inspect files before sharing them. Redaction cannot be assumed to catch every personal detail. Session setup, mobile devices, scheduled CI runs, team permissions, and a shared server are outside this alpha's scope.
69
+ Reports and raw evidence can contain data from the tested app. `.flowqa/` is Git-ignored, but inspect files before sharing them. Redaction cannot be assumed to catch every personal detail. Session setup, mobile devices, scheduled CI runs, team permissions, and a shared server are outside the current scope.
68
70
 
69
71
  ![QA report from three real passing cases](https://raw.githubusercontent.com/hyeonse-swing/flow-qa/main/docs/media/flow-qa-report.png)
70
72
 
package/docs/architecture.md CHANGED
@@ -35,4 +35,4 @@ flowchart LR
35
35
  | Results | A fresh report per run, status interpretation, evidence links | Raw runs and evidence from the engine |
36
36
  | UI | Local workflow screens and English/Korean language switch | [Hyeonse Design System](https://github.com/hyeonse-swing/hyeonse-design-system) tokens and preference utilities |
37
37
 
38
- The UI binds only to `127.0.0.1` and serves approved report evidence, not arbitrary raw logs or HTML/SVG. Local reports may still contain data from the tested app and should be reviewed before sharing. This alpha does not manage login sessions, cap model spending, schedule CI runs, or support mobile devices.
38
+ The UI binds only to `127.0.0.1` and serves approved report evidence, not arbitrary raw logs or HTML/SVG. Local reports may still contain data from the tested app and should be reviewed before sharing. This release does not manage login sessions, cap model spending, schedule CI runs, or support mobile devices.
package/docs/releases.md CHANGED
@@ -1,6 +1,46 @@
1
- # Alpha release and verification
1
+ # Releases and verification
2
2
 
3
- ## 0.1.0-alpha.3
3
+ The alpha entries below are historical release records. They document earlier package versions and checks.
4
+
5
+ ## Automated npm releases
6
+
7
+ A push to `main` publishes only when `package.json` changes to a new plain `X.Y.Z` version. Pull requests and pushes without a version change run verification without publishing. The package and lockfile versions must agree; the version must increase, and registry errors stop the release. Rerunning a successful publication skips the existing immutable npm version.
8
+
9
+ The `publish` job in [ci.yml](../.github/workflows/ci.yml) waits for the full verification job, then publishes through npm trusted publishing (OIDC). It uses the `latest` tag and checks the published package with a fresh consumer installation and three real Chromium demo cases. No npm token is stored in GitHub secrets.
10
+
11
+ For the next release, update the release notes and current installation examples, then bump the version before committing and pushing:
12
+
13
+ ```sh
14
+ npm version patch --no-git-tag-version
15
+ npm run check
16
+ ```
17
+
18
+ Push the version change to `main` and check the **Verify release** workflow. A successful verification job alone does not confirm publication: the publish job and its registry smoke check must also pass. Retry a transient failure by rerunning the same workflow; do not reuse a published version for different package contents.
19
+
20
+ The npm trusted publisher is configured for GitHub repository `hyeonse-swing/flow-qa`, workflow `ci.yml`, with direct publishing allowed. See [npm's trusted publishing documentation](https://docs.npmjs.com/trusted-publishers/) for account setup.
21
+
22
+ ## 0.1.2
23
+
24
+ Adds version-gated npm publishing from GitHub Actions and npm links in both README languages. Runtime behavior is unchanged from 0.1.1.
25
+
26
+ - Package: [`@ihyeon/flow-qa@0.1.2`](https://www.npmjs.com/package/@ihyeon/flow-qa/v/0.1.2)
27
+ - Verification and publication: [GitHub Actions](https://github.com/hyeonse-swing/flow-qa/actions/workflows/ci.yml)
28
+
29
+ ## 0.1.1
30
+
31
+ This release uses plain semver and the npm `latest` dist-tag. It includes the runtime fixes documented in the historical entry below, with no additional runtime changes. The existing runtime passed 47 tests and the browser checks recorded there. Version 0.1.1 metadata, package contents, and a fresh consumer installation were also verified: the installed `flow-qa` command worked and all three Chromium demo cases passed without model calls.
32
+
33
+ - Package target: [`@ihyeon/flow-qa@0.1.1`](https://www.npmjs.com/package/@ihyeon/flow-qa/v/0.1.1), npm `latest` dist-tag
34
+ - Source and package: [GitHub release](https://github.com/hyeonse-swing/flow-qa/releases/tag/v0.1.1)
35
+ - Public checks: [GitHub Actions](https://github.com/hyeonse-swing/flow-qa/actions/workflows/ci.yml)
36
+
37
+ Use the matching source revision when checking this historical package:
38
+
39
+ ```sh
40
+ FLOWQA_PACKAGE_SPEC=@ihyeon/flow-qa@0.1.1 npm run smoke:package
41
+ ```
42
+
43
+ ## Historical: 0.1.0-alpha.3
4
44
 
5
45
  This maintenance release keeps the existing CLI, UI, and case schema. It tightens result validation, bounds UI shutdown, and checks the command that npm installs for consumers.
6
46
 
@@ -29,7 +69,7 @@ npm run smoke:package
29
69
  FLOWQA_PACKAGE_SPEC=@ihyeon/flow-qa@0.1.0-alpha.3 npm run smoke:package
30
70
  ```
31
71
 
32
- ## 0.1.0-alpha.2
72
+ ## Historical: 0.1.0-alpha.2
33
73
 
34
74
  This update replaces the introductory video link with two UI screenshots. Runtime behavior is unchanged from alpha.1. Media files are not included in the npm tarball.
35
75
 
package/docs/ui.md CHANGED
@@ -4,10 +4,10 @@ Use the target app's URL and a user flow to review cases, run them, and inspect
4
4
 
5
5
  ## Start
6
6
 
7
- Node.js 24 or later is required. Install the alpha and start the local demo:
7
+ Node.js 24 or later is required. Install Flow QA and start the local demo:
8
8
 
9
9
  ```sh
10
- npm install -g @ihyeon/flow-qa@0.1.0-alpha.2
10
+ npm install -g @ihyeon/flow-qa@0.1.2
11
11
  flow-qa browser install
12
12
  flow-qa ui --demo
13
13
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ihyeon/flow-qa",
3
- "version": "0.1.0-alpha.3",
3
+ "version": "0.1.2",
4
4
  "license": "MIT",
5
5
  "author": "Hyeonse Im",
6
6
  "repository": {
@@ -21,7 +21,7 @@
21
21
  ],
22
22
  "publishConfig": {
23
23
  "access": "public",
24
- "tag": "alpha",
24
+ "tag": "latest",
25
25
  "registry": "https://registry.npmjs.org/"
26
26
  },
27
27
  "files": [