-
Notifications
You must be signed in to change notification settings - Fork 0
[Fix-95] FE 배포 관련 문서화 #36
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
yeomin4242
merged 10 commits into
main
from
FIX-95-Story-10.5-FE-Web-Release-Readiness-Pack
Mar 25, 2026
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
7662cfd
Feat: add web release readiness checklist and notes for version 0.1.0…
yeomin4242 d9f6199
Feat: add web release readiness checklist, notes, and test matrix for…
yeomin4242 3901596
Feat: enhance live notification center tests and add portfolio access…
yeomin4242 c12fd61
Feat: add script to generate web release notes and readiness checklis…
yeomin4242 208fe2c
Feat: add unit tests for web release readiness pack functionality FIX-95
yeomin4242 f8654ad
Feat: add release readiness pack and update Playwright configuration …
yeomin4242 2e52d9c
Fix: update .env.example reference in web release test matrix notes F…
yeomin4242 18dc850
Fix: refactor environment variable loading in check-live-auth-contrac…
yeomin4242 6913a6e
Fix: enhance README checks in web release readiness tests FIX-95
yeomin4242 6cd20db
Fix: enhance environment variable handling in Playwright configuratio…
yeomin4242 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
29 changes: 29 additions & 0 deletions
29
docs/release/candidates/v0.1.0/playwright-release-summary.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| <!-- Generated by scripts/generate-release-notes.mjs --> | ||
|
|
||
| # FE Release-Critical Playwright Evidence Summary | ||
|
|
||
| ## Candidate | ||
|
|
||
| - Version: `0.1.0` | ||
| - Command: `pnpm run e2e:release` | ||
| - Validation date: `<YYYY-MM-DD>` | ||
| - Environment: `<fill-in-environment>` | ||
|
|
||
| ## Covered Specs | ||
|
|
||
| - `e2e/live/auth-live.spec.ts` | ||
| - `e2e/live/order-session-live.spec.ts` | ||
| - `e2e/live/notification-center-live.spec.ts` | ||
| - `e2e/live/notification-stream-live.spec.ts` | ||
| - `e2e/live/portfolio-dashboard-live.spec.ts` | ||
|
|
||
| ## Reviewer-Facing Evidence | ||
|
|
||
| - Result summary: `<fill-in-pass-fail-summary>` | ||
| - This markdown file is the checked-in, repository-stable evidence record for reviewers. | ||
| - External artifact URL or attachment path: `<fill-in-ci-artifact-or-attachment>` | ||
|
|
||
| ## Notes | ||
|
|
||
| - Raw `playwright-report/` output is intentionally not tracked in git. | ||
| - Attach the CI artifact URL or an exported bundle in the candidate release notes when finalizing approval. |
21 changes: 21 additions & 0 deletions
21
docs/release/candidates/v0.1.0/upstream-story-10.1-evidence.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| <!-- Generated by scripts/generate-release-notes.mjs --> | ||
|
|
||
| # Story 10.1 Upstream Evidence Record | ||
|
|
||
| ## Expected Evidence | ||
|
|
||
| - Acceptance CI gate run URL | ||
| - Scenario traceability artifact or report | ||
| - Owner acknowledgement for the exact FE candidate | ||
|
|
||
| ## Current Status | ||
|
|
||
| - Status: `Pending upstream completion` | ||
| - This file is the candidate-specific evidence record linked from the FE release checklist. | ||
| - Replace the placeholders below with actual evidence links before final shipment. | ||
|
|
||
| ## Evidence Links | ||
|
|
||
| - CI gate run URL: `<fill-in-ci-run-url>` | ||
| - Scenario traceability artifact: `<fill-in-traceability-link>` | ||
| - Reviewer note: `<fill-in-note>` |
21 changes: 21 additions & 0 deletions
21
docs/release/candidates/v0.1.0/upstream-story-10.4-evidence.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| <!-- Generated by scripts/generate-release-notes.mjs --> | ||
|
|
||
| # Story 10.4 Upstream Evidence Record | ||
|
|
||
| ## Expected Evidence | ||
|
|
||
| - Smoke rehearsal execution record | ||
| - Rollback verification evidence | ||
| - Owner acknowledgement for the exact FE candidate | ||
|
|
||
| ## Current Status | ||
|
|
||
| - Status: `Pending upstream completion` | ||
| - This file is the candidate-specific evidence record linked from the FE release checklist. | ||
| - Replace the placeholders below with actual evidence links before final shipment. | ||
|
|
||
| ## Evidence Links | ||
|
|
||
| - Smoke rehearsal artifact: `<fill-in-smoke-artifact>` | ||
| - Rollback verification artifact: `<fill-in-rollback-link>` | ||
| - Reviewer note: `<fill-in-note>` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| <!-- Generated by scripts/generate-release-notes.mjs --> | ||
|
|
||
| # Web Release Readiness Checklist | ||
|
|
||
| ## Candidate Metadata | ||
|
|
||
| | Field | Value | | ||
| | --- | --- | | ||
| | Candidate version | `0.1.0` | | ||
| | Commit SHA | `<fill-in-fe-sha>` (FE), `<fill-in-repo-sha>` (repo) | | ||
| | Reviewer / release owner | `<fill-in-release-owner>` | | ||
| | Validation date | `<YYYY-MM-DD>` | | ||
| | Environment | `<fill-in-environment>` | | ||
|
|
||
| ## Automated Release Gate | ||
|
|
||
| | Gate | Command | Evidence | | ||
| | --- | --- | --- | | ||
| | FE type-check | `pnpm run type-check` | `<fill-in-evidence>` | | ||
| | FE lint | `pnpm run lint` | `<fill-in-evidence>` | | ||
| | FE unit/integration | `pnpm run test` | `<fill-in-evidence>` | | ||
| | FE build | `pnpm run build` | `<fill-in-evidence>` | | ||
| | FE live preflight | `pnpm run e2e:live:preflight` | `<fill-in-evidence>` | | ||
| | FE release-critical Playwright | `pnpm run e2e:release` | See `./playwright-release-summary.md` | | ||
|
|
||
| ## Critical Journey Evidence | ||
|
|
||
| | Journey | Primary specs | Evidence | | ||
| | --- | --- | --- | | ||
| | Auth register/login/reset guidance | `e2e/live/auth-live.spec.ts` | See `./playwright-release-summary.md` | | ||
| | Order create/execute/result | `e2e/live/order-session-live.spec.ts` | See `./playwright-release-summary.md` | | ||
| | Notification feed and mark-read | `e2e/live/notification-center-live.spec.ts` | See `./playwright-release-summary.md` | | ||
| | Notification stream reconnect | `e2e/live/notification-stream-live.spec.ts` | See `./playwright-release-summary.md` | | ||
| | Portfolio boundary and bootstrap | `e2e/live/portfolio-dashboard-live.spec.ts` | See `./playwright-release-summary.md` | | ||
|
|
||
| ## Documentation Consistency | ||
|
|
||
| | Artifact | Check | Evidence | | ||
| | --- | --- | --- | | ||
| | `README.md` | Dual-audience path, Quick Start, Architecture Decisions, Environment Variables, and security narrative remain accurate | Verified by `tests/unit/release/web-release-readiness-pack.test.ts` and manual README pass | | ||
| | `BE/README.md` | Backend setup guidance still matches shipped runtime | `<fill-in-evidence>` | | ||
| | `FE/README.md` | FE local setup and release commands match actual scripts | Verified by `tests/unit/release/web-release-readiness-pack.test.ts` | | ||
| | `.env.example` | Root infra variables remain accurate | `<fill-in-evidence>` | | ||
| | `FE/.env.example` | FE runtime and `LIVE_*` release variables remain accurate | Verified by `tests/unit/release/web-release-readiness-pack.test.ts` | | ||
| | `BE/application-local.yml.template` | Reviewer-facing backend local profile guidance still matches service-local files | `<fill-in-evidence>` | | ||
|
|
||
| ## Upstream Release Evidence | ||
|
|
||
| | Upstream story | Expected evidence | Link | | ||
| | --- | --- | --- | | ||
| | Story 10.1 | Acceptance CI gate report / scenario traceability | [upstream-story-10.1-evidence.md](./upstream-story-10.1-evidence.md) | | ||
| | Story 10.4 | Smoke rehearsal / rollback evidence | [upstream-story-10.4-evidence.md](./upstream-story-10.4-evidence.md) | | ||
|
|
||
| ## Signoff | ||
|
|
||
| | Question | Result | | ||
| | --- | --- | | ||
| | Critical FE journeys pass? | `<fill-in-result>` | | ||
| | Core auth/order regressions block release? | `<fill-in-result>` | | ||
| | Documentation set mutually consistent? | `<fill-in-result>` | | ||
| | Candidate approved for release notes finalization? | `<fill-in-result>` | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| <!-- Generated by scripts/generate-release-notes.mjs --> | ||
|
|
||
| # Web Release Notes | ||
|
|
||
| > Candidate-specific FE release notes for version `0.1.0`. | ||
| > Generated from `docs/release/web-release-notes.md`. Draft candidate files are safe to regenerate until the approval status changes from draft. | ||
|
|
||
| ## Candidate | ||
|
|
||
| - Version: `0.1.0` | ||
| - FE commit SHA: `<fill-in-at-candidate-cut>` | ||
| - Repo commit SHA: `<fill-in-at-candidate-cut>` | ||
| - Release owner: `<fill-in-release-owner>` | ||
| - Validation date: `<YYYY-MM-DD>` | ||
|
|
||
| ## Included Scope | ||
|
|
||
| - Story 10.5 web release readiness packaging | ||
| - README / local setup consistency verification | ||
| - FE live auth, order, and notification critical-journey validation | ||
| - FE live portfolio dashboard boundary and bootstrap validation | ||
| - Additional candidate-specific scope: `<fill-in-if-needed>` | ||
|
|
||
| ## Evidence Summary | ||
|
|
||
| - Release checklist: `./web-readiness-checklist.md` | ||
| - Test matrix: `../../web-test-matrix.md` | ||
| - Playwright evidence summary: `./playwright-release-summary.md` | ||
| - CI run URL: `<fill-in-ci-run-url>` | ||
| - Story 10.1 upstream evidence: `./upstream-story-10.1-evidence.md` | ||
| - Story 10.4 upstream evidence: `./upstream-story-10.4-evidence.md` | ||
|
|
||
| ## Known Risks / Follow-ups | ||
|
|
||
| - Final shipment still depends on upstream Story 10.1 and Story 10.4 evidence closing in the shared release gate. | ||
| - Candidate-specific residual risks: `<fill-in-if-needed>` | ||
|
|
||
| ## Approval | ||
|
|
||
| - Approval status: `Draft - pending validation evidence` | ||
| - Reviewer notes: `<fill-in-review-summary>` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| # Web Release Readiness Checklist Guide | ||
|
|
||
| This file is the checked-in entry point for FE release checklists. Candidate-specific completed checklists must live under `docs/release/candidates/v<semver>/web-readiness-checklist.md` so release metadata and evidence stay scoped to the exact FE candidate. | ||
|
|
||
| Do not record candidate-specific SHAs, dates, or approval state in this guide. Put those details in the candidate file instead. | ||
|
|
||
| ## Generate Candidate Pack | ||
|
|
||
| Run the scaffold command after the FE release gate passes: | ||
|
|
||
| ```bash | ||
| pnpm run release:notes | ||
| ``` | ||
|
|
||
| The command reads the FE version from `package.json`, creates the candidate directory under `docs/release/candidates/v<package-version>/`, and refreshes the draft candidate pack until the generated release notes are finalized with a non-draft approval status. | ||
|
|
||
| Current FE package version path: | ||
|
|
||
| - `docs/release/candidates/v0.1.0/web-readiness-checklist.md` | ||
|
|
||
| ## Candidate Companion Files | ||
|
|
||
| Each candidate directory should keep these reviewer-facing evidence records together: | ||
|
|
||
| - `web-readiness-checklist.md` | ||
| - `web-release-notes.md` | ||
| - `playwright-release-summary.md` | ||
| - `upstream-story-10.1-evidence.md` | ||
| - `upstream-story-10.4-evidence.md` | ||
|
|
||
| ## Checklist Contract | ||
|
|
||
| Every candidate checklist should include these sections: | ||
|
|
||
| - `## Candidate Metadata` | ||
| - `## Automated Release Gate` | ||
| - `## Critical Journey Evidence` | ||
| - `## Documentation Consistency` | ||
| - `## Upstream Release Evidence` | ||
| - `## Signoff` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # Web Release Notes Guide | ||
|
|
||
| This file is the checked-in entry point for FE release notes. Candidate-specific notes must live under `docs/release/candidates/v<semver>/web-release-notes.md` so each FE candidate keeps its own immutable evidence trail. | ||
|
|
||
| Do not record candidate-specific approval state, dates, or commit SHAs in this file. Put those details in the generated candidate file instead. | ||
|
|
||
| ## Generate Candidate Notes | ||
|
|
||
| Run the scaffold command after the FE release gate passes: | ||
|
|
||
| ```bash | ||
| pnpm run release:notes | ||
| ``` | ||
|
|
||
| The command reads the FE version from `package.json`, creates the candidate directory under `docs/release/candidates/v<package-version>/`, and refreshes the draft candidate pack until the release notes are finalized with a non-draft approval status. | ||
|
|
||
| Current FE package version path: | ||
|
|
||
| - `docs/release/candidates/v0.1.0/web-release-notes.md` | ||
|
|
||
| ## What Belongs In The Generated File | ||
|
|
||
| - candidate metadata for the exact FE candidate under review | ||
| - links to the candidate checklist and shared test matrix | ||
| - links to CI and Playwright evidence for that candidate | ||
| - links to candidate-specific upstream Story 10.1 and Story 10.4 evidence records | ||
| - approval outcome and reviewer notes for that version only | ||
|
|
||
| ## Template Contract | ||
|
|
||
| Every generated candidate file should include these sections: | ||
|
|
||
| - `## Candidate` | ||
| - `## Included Scope` | ||
| - `## Evidence Summary` | ||
| - `## Known Risks / Follow-ups` | ||
| - `## Approval` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # Web Release Test Matrix | ||
|
|
||
| ## Target Lanes | ||
|
|
||
| | Lane | Purpose | Command / Spec Set | Pass Rule | | ||
| | --- | --- | --- | --- | | ||
| | `live-auth` | Register, login, password-recovery, and correlation-id behavior against live backend | `pnpm run e2e:release` (`e2e/live/auth-live.spec.ts`) | All auth scenarios pass with no uncaught browser errors | | ||
| | `live-order` | Order session create/execute/result against live backend | `pnpm run e2e:release` (`e2e/live/order-session-live.spec.ts`) | Order flow reaches deterministic success or documented guarded result | | ||
| | `live-notification-center` | Notification list hydration and mark-read UX | `pnpm run e2e:release` (`e2e/live/notification-center-live.spec.ts`) | Feed renders, updates, and mark-read completes | | ||
| | `live-notification-stream` | Reconnect and SSE hydration behavior | `pnpm run e2e:release` (`e2e/live/notification-stream-live.spec.ts`) | Stream reconnect path restores live state without manual browser repair | | ||
| | `live-portfolio-dashboard` | Portfolio boundary, bootstrap, and dashboard history rendering against live backend | `pnpm run e2e:release` (`e2e/live/portfolio-dashboard-live.spec.ts`) | Anonymous access is blocked and a live authenticated portfolio session renders summary/history without UI contract drift | | ||
|
|
||
| ## Supporting Quality Gates | ||
|
|
||
| | Gate | Command | Purpose | | ||
| | --- | --- | --- | | ||
| | Type check | `pnpm run type-check` | TS contract integrity | | ||
| | Lint | `pnpm run lint` | Static code quality | | ||
| | Unit and integration | `pnpm run test` | FE behavior regression coverage | | ||
| | Build | `pnpm run build` | Production bundle validity | | ||
| | Live preflight | `pnpm run e2e:live:preflight` | Backend auth contract readiness | | ||
|
|
||
| ## Notes | ||
|
|
||
| - `pnpm run release:check` is the canonical FE release gate command for Story 10.5. | ||
| - `.env.example` is the checked-in source for the `LIVE_*` variables consumed by the FE release gate, and both the Playwright config and live preflight script load `.env.local` automatically. | ||
| - Final release approval should attach the checked-in `playwright-release-summary.md` record and CI artifact URL to the candidate checklist under `docs/release/candidates/v<semver>/`. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.