Skip to content

docs(roadmap): mark v0 alpha banner and CLI import guard as done - #1741

Merged
yamcodes merged 3 commits into
v1from
update_roadmap_alpha_banner
Sep 2, 2026
Merged

docs(roadmap): mark v0 alpha banner and CLI import guard as done#1741
yamcodes merged 3 commits into
v1from
update_roadmap_alpha_banner

Conversation

@yamcodes

@yamcodes yamcodes commented Sep 2, 2026

Copy link
Copy Markdown
Owner

Summary

  • Marks v0 site Alpha banner as done in ROADMAP_EXTRAS (apps/www/lib/roadmap/config.ts) and checks off the corresponding item in docs/LAUNCH_RUNBOOK.md (fulfilled by live announcement on v0 site pointing to v1 alpha docs).
  • Marks Add CLI import guard for v0 upgrades as done in ROADMAP_EXTRAS (apps/www/lib/roadmap/config.ts) (fulfilled by the runtime import guard in packages/arkenv/src/index.ts and verified via packages/arkenv/src/smoke.test.ts).
  • Aligned Step 2.4 in docs/LAUNCH_RUNBOOK.md to Validate CLI Import Guard.

Verification

  • pnpm check passed cleanly
  • pnpm --filter www test -- --run passed (51 test suites, 202 tests)
  • pnpm typecheck passed

- Marks 'v0-alpha-banner' and 'cli-postinstall-guard' as done in ROADMAP_EXTRAS.
- Updates LAUNCH_RUNBOOK.md checking off the v0 alpha banner.
@changeset-bot

changeset-bot Bot commented Sep 2, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: c70fc40

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions Bot added docs Adds or changes documentation, or acts as documentation in and of itself www Improvements or additions to arkenv.js.org labels Sep 2, 2026

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ℹ️ Both claims verify against current state — one terminology nit inline.

Reviewed changes

  • v0 site Alpha banner → doneROADMAP_EXTRAS.v0-alpha-banner flipped to done: true in apps/www/lib/roadmap/config.ts, moving it from "Up next" to the Done group on the public roadmap; the matching Alpha Banner on Live v0 Site pre-launch item is checked off in docs/LAUNCH_RUNBOOK.md.
  • CLI postinstall guard → doneROADMAP_EXTRAS.cli-postinstall-guard flipped to done: true in apps/www/lib/roadmap/config.ts.

Confirmed the supporting evidence: the live v0 site at arkenv.js.org shows an "ArkEnv v1 is in alpha!" banner linking to https://arkenv-v1.vercel.app/, and the CLI guard ships as a module-eval throw in packages/arkenv/src/index.ts exercised by the four-case library import guard suite in packages/arkenv/src/smoke.test.ts. Roadmap tests mock the config module, so the flips don't disturb them.

Pullfrog  | Fix all ➔Fix 👍s ➔View workflow run | Using DeepSeek Flash (free via Pullfrog for OSS) | 𝕏

Comment thread apps/www/lib/roadmap/config.ts
Renames 'Add CLI postinstall guard for v0 upgrades' to 'Add CLI import guard for v0 upgrades' to match the actual shipped mechanism, and aligns Step 2.4 in LAUNCH_RUNBOOK.md.
@yamcodes yamcodes changed the title docs(roadmap): mark v0 alpha banner and CLI postinstall guard as done docs(roadmap): mark v0 alpha banner and CLI import guard as done Sep 2, 2026
@yamcodes

yamcodes commented Sep 2, 2026

Copy link
Copy Markdown
Owner Author

@pullfrog review please

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ℹ️ Minor suggestions only — one stale phrase inside the step you retitled.

Note: this review was written against head 97a576c9; if commits land on update_roadmap_alpha_banner after that, re-diff before acting.

Reviewed changes

  • Marked the v0 site Alpha banner roadmap extra (apps/www/lib/roadmap/config.ts) and its LAUNCH_RUNBOOK checklist item as done — verified the banner is live on arkenv.js.org.
  • Marked CLI import guard for v0 upgrades as done and retitled it from "postinstall guard" — accurate, since arkenv's package.json has no postinstall script; the guard lives in packages/arkenv/src/index.ts:3 and is covered by the smoke.test.ts library-import-guard suite.

Both done flips render correctly (the roadmap page splits done vs open items and re-sorts extras by done), and the roadmap tests pass.

ℹ️ Nitpicks

  • docs/LAUNCH_RUNBOOK.md:61 — the retitled step "Validate CLI Import Guard" still says "Verify that npm install arkenv… throws the clear runtime error". The guard fires on import, not install (no postinstall hook exists), so the bullet's npm install wording contradicts the corrected heading.

Pullfrog  | Fix it ➔View workflow run | Using DeepSeek Flash (free via Pullfrog for OSS) | 𝕏

Aligns verification bullet to clarify that importing or requiring arkenv throws the runtime error, rather than npm install.
@yamcodes

yamcodes commented Sep 2, 2026

Copy link
Copy Markdown
Owner Author

Addressed review nitpick in c70fc40: updated Step 2.4 in docs/LAUNCH_RUNBOOK.md to state that importing or requiring arkenv as a library throws the runtime error, removing the stale npm install phrasing.

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ No new issues found.

Reviewed changes

  • Reworded runbook Step 2.4 (docs/LAUNCH_RUNBOOK.md) so its bullet describes the guard correctly: "importing or requiring arkenv as a library (import arkenv from "arkenv" / require("arkenv"))" throws the migration error, replacing the stale "npm install arkenv… throws" phrasing. This resolves the nitpick raised in the prior review.

Verified the new wording against the shipped mechanism — the guard is a module-eval throw at packages/arkenv/src/index.ts:3, and packages/arkenv/src/smoke.test.ts:16 covers both ESM import and CJS require. The roadmap item title and the runbook step now consistently describe an import-time guard (no postinstall hook exists).

Pullfrog  | View workflow run | Using DeepSeek Flash (free via Pullfrog for OSS) | 𝕏

@yamcodes
yamcodes merged commit 97746a5 into v1 Sep 2, 2026
17 checks passed
@yamcodes
yamcodes deleted the update_roadmap_alpha_banner branch September 2, 2026 17:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Adds or changes documentation, or acts as documentation in and of itself www Improvements or additions to arkenv.js.org

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant