From 2dd9eba8b8b3c38b1c091d9240fa6b9fe8243e79 Mon Sep 17 00:00:00 2001 From: Nicu Chiciuc Date: Sat, 31 Oct 2026 17:08:13 +0200 Subject: [PATCH] Name the state project alchemy-state-store in the docs alchemy-convex 0.16.0 keeps the state in alchemy-state-store, so the two state commands in the README named a project that does not exist. Co-Authored-By: Claude Opus 5.5 --- .github/workflows/alchemy.yml | 2 +- README.md | 10 +++++----- alchemy.run.ts | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/alchemy.yml b/.github/workflows/alchemy.yml index b739d57..3e728f3 100644 --- a/.github/workflows/alchemy.yml +++ b/.github/workflows/alchemy.yml @@ -2,7 +2,7 @@ # the production deployment. A pull request from this repository deploys the stage # `pr-`, a preview with that name; closing the pull request destroys the # stage and deletes the preview. The state of every stage is in the -# `alchemy-state` project of the team, under the stack name GITHUB_REPOSITORY. +# `alchemy-state-store` project of the team, under the stack name GITHUB_REPOSITORY. # Every run needs only the team token CONVEX_ACCESS_TOKEN; it mints the deploy # keys itself. Only the Alchemy steps get the secret. on: diff --git a/README.md b/README.md index 6d0b72c..547db1a 100644 --- a/README.md +++ b/README.md @@ -42,11 +42,11 @@ create todos, see real-time updates, and scan a QR code to open the same list on [GitHub CLI](https://cli.github.com/): `CONVEX_ACCESS_TOKEN`, a team access token. Generate it in the Convex dashboard (the team, **Settings**, **Access Tokens**), copy it, and run `gh secret set CONVEX_ACCESS_TOKEN`, which asks for the pasted value without showing it. The - token creates the Convex project of the repository, the state project `alchemy-state` of the + token creates the Convex project of the repository, the state project `alchemy-state-store` of the team, and the short-lived deploy keys of each run. No deploy key is stored anywhere. 5. Push to `main`, or run `alchemy.yml` from the **Actions** tab. The first run creates the project, named after the repository, with its production deployment, pushes to it, and keeps the state of - the stage `prod` in `alchemy-state`. Each push to `main` deploys from then on, and each pull + the stage `prod` in `alchemy-state-store`. Each push to `main` deploys from then on, and each pull request deploys the preview `pr-` and comments its URL on the pull request. The run's log ends with the site URL, `https://.convex.site`. When the team has a project with the name of the repository already, such as one that `pnpm run dev` created, the first run stops: run @@ -117,7 +117,7 @@ preview deployment with that name whose URL, `https://.convex.site`, the pull request, and destroys that stage when the pull request closes, all with the team token `CONVEX_ACCESS_TOKEN`. The stack is named after the repository, `owner/name` (`GITHUB_REPOSITORY`, or the origin remote on a laptop), and so is its Convex project. Every run, in CI or local, keeps -the state of its stage in the `alchemy-state` project of the team, which the first run creates, +the state of its stage in the `alchemy-state-store` project of the team, which the first run creates, under the stack name; the stage `prod` owns the project, and `alchemy destroy --stage prod` deletes it. The state has no lock, so the workflow runs one deploy of a stage at a time. A local run uses `npx convex login` when `CONVEX_ACCESS_TOKEN` is not set: @@ -156,14 +156,14 @@ moves it once: mutation, signed in with `npx convex login`: ```sh - npx convex run --deployment :alchemy-state:prod state:removeStack "{stack: 'owner/name', stage: 'main'}" + npx convex run --deployment :alchemy-state-store:prod state:removeStack "{stack: 'owner/name', stage: 'main'}" ``` 3. Check the stages that are left; the list has `prod` and the `pr-` stages of open pull requests: ```sh - npx convex run --deployment :alchemy-state:prod state:stages "{stack: 'owner/name'}" + npx convex run --deployment :alchemy-state-store:prod state:stages "{stack: 'owner/name'}" ``` ## Important files diff --git a/alchemy.run.ts b/alchemy.run.ts index 6b8bc6e..73acd69 100644 --- a/alchemy.run.ts +++ b/alchemy.run.ts @@ -5,7 +5,7 @@ // Convex Auth keys, uploads the site, and pushes the functions. // // The stack is named after the repository, `owner/name`, and its Convex -// project after `name`. The state of every stage is in the `alchemy-state` +// project after `name`. The state of every stage is in the `alchemy-state-store` // project of the team, which Convex.state() creates on the first run. Every // run needs the team token CONVEX_ACCESS_TOKEN, or a Convex CLI login // (`npx convex login`) on a laptop; it mints the deploy keys itself.