@samebase/alchemy-convex 0.16.0 → 0.18.0

package/NOTICE

@@ -8,6 +8,9 @@ packages/alchemy, under the ISC license:
 - the Convex CLI runner in src/Push.ts (internal/CommandRunner.ts),
 - the deployment lookup rules in src/Deployment.ts and the project listing in src/Project.ts.
 
+The Workers and R2 icons in assets/stack-comment are by Cloudflare, under CC BY 4.0
+(https://creativecommons.org/licenses/by/4.0/), with Cloudflare orange fill.
+
 ISC License
 
 Copyright 2024 RJ Dellecese

package/README.md

@@ -276,7 +276,7 @@ call.
 
 - `Convex.HubClient`: `{ team, app, redirectUri, deploymentType, clientName, softwareVersion? }`
   registers one deployment as a client of the identity hub of the team. The hub is the production
-  deployment of the project `samebase`. The resource finds it by name and runs
+  deployment of the project `identity-hub`. The resource finds it by name and runs
   its internal function `identityBroker:registerClient` with a short-lived key, so the stack needs no
   other credential and no hub address. The first client of an `app` creates the app. Outputs
   `issuer`, `clientId`, `clientSecret`, `redirectUri`, `deploymentType`, and `clientName`, which the
@@ -292,6 +292,33 @@ of the app, before the first push: it registers the deployment of that directory
 npx alchemy-convex hub-client --team my-team --app scout --callback-path /auth/hub/callback
 ```
 
+## Pull request comment
+
+`alchemy-convex stack-comment` keeps one comment on a pull request. The comment has a card for each
+stack of the repository at the stage `pr-<number>`: the folder, the address, the last run, and the
+Convex deployments, Workers, and R2 buckets. A stack sees only itself, so a comment that a stack
+declares cannot show this.
+
+Run it after every deploy of the workflow. The run record gives the repository and the pull request,
+so the command needs no argument with a team access token:
+
+```yaml
+permissions:
+  pull-requests: write
+
+steps:
+  # The deploy steps of each stack.
+  - name: Update the stack comment
+    if: github.event_name == 'pull_request'
+    run: pnpm exec alchemy-convex stack-comment
+    env:
+      CONVEX_ACCESS_TOKEN: ${{ secrets.CONVEX_ACCESS_TOKEN }}
+      GITHUB_TOKEN: ${{ github.token }}
+```
+
+A stack named `owner/name`, or `owner/name/<folder>` for a stack in a folder, belongs to the
+repository `owner/name`. A stack without the stage of the pull request has no card.
+
 ## Data safety
 
 - `Convex.Project` and `Convex.Deployment` have the removal policy `retain`. `alchemy destroy`

package/lib/{HubClient-BYBV7cF5.js → HubClient-BZKweNfD.js}

@@ -1782,7 +1782,7 @@ const state = (options = {}) => Layer.effect(State, Effect.gen(function* () {
 //#endregion
 //#region src/HubClient.ts
 /** The name of the project of the hub in each team. */
-const HUB_PROJECT_NAME = "samebase";
+const HUB_PROJECT_NAME = "identity-hub";
 const HubClient = Resource("IdentityHub.Client");
 /** The hub of the team could not do the call. The reason is the Convex message: it holds no secret. */
 var HubClientFailed = class extends Schema.TaggedError()("HubClientFailed", {
@@ -1910,4 +1910,4 @@ const registerDevelopmentClient = (options) => Effect.gen(function* () {
 //#endregion
 export { PushTargetMismatch as A, DEPLOY_KEY_ENV as B, DeploymentProvider as C, ConvexAppNotFound as D, CodePushFailed as E, ManagementApi as F, fromValues as H, ManagementApiLive as I, ACCESS_TOKEN_ENV as L, installedCli as M, parseDeployOutput as N, ConvexCliNotFound as O, ConvexApiError as P, Credentials as R, DeploymentIdentityChange as S, ProductionDeploymentNotFound as T, fromConfig as V, ProjectProvider as _, registerDevelopmentClient as a, AmbiguousDeployment as b, RUN_RECORD_KEY as c, withRunRecord as d, AmbiguousProject as f, ProjectNotFound as g, ProjectDeploymentChange as h, HubClientProvider as i, VariablesOwnedBySomeoneElse as j, EnvironmentNeedsDeployKey as k, RunRecordError as l, Project as m, HubClient as n, STORE_PROJECT_NAME as o, CreatedProjectNotFound as p, HubClientFailed as r, state as s, HUB_PROJECT_NAME as t, runRecord as u, ProjectTeamChange as v, DeploymentResource as w, Deployment as x, AbsoluteRootDir as y, CredentialsError as z };
 
-//# sourceMappingURL=HubClient-BYBV7cF5.js.map
+//# sourceMappingURL=HubClient-BZKweNfD.js.map